modpoll 1.3.0__tar.gz → 1.4.0__tar.gz

{modpoll-1.3.0 → modpoll-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: modpoll
-Version: 1.3.0
+Version: 1.4.0
 Summary: A New Command-line Tool for Modbus and MQTT
 Home-page: https://github.com/gavinying/modpoll
 Author: Ying Shaodong
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: serial
 Requires-Dist: paho-mqtt (>=2.1.0,<3.0.0)
 Requires-Dist: prettytable (>=3.9.0,<4.0.0)
@@ -28,7 +29,7 @@ Description-Content-Type: text/markdown
 [![License](https://img.shields.io/github/license/gavinying/modpoll)](https://img.shields.io/github/license/gavinying/modpoll)
 [![Downloads](https://static.pepy.tech/badge/modpoll/week)](https://pepy.tech/project/modpoll)
 
-Show your love for this project by starring our repo 🌟, so we are encouraged to continue improving.
+> 📢 **Announcement:** Since the release of v1.3.0, our official dockerhub namespace has been changed to `topmaker`, you can pull the latest images from [topmaker/modpoll](https://hub.docker.com/repository/docker/topmaker/modpoll) at dockerhub.
 
 > Learn more about *modpoll* usage at [documentation](https://gavinying.github.io/modpoll) site.
 
@@ -182,7 +183,7 @@ The configuration can be either a local file or a remote public URL resource.
 If you are blocked by company firewall for online device or prefer a local test, you can launch your own device simulator by running *modsim* locally,
 
 ```bash
-docker run --rm -p 5020:5020 helloysd/modsim
+docker run --rm -p 5020:5020 topmaker/modsim
 ```
 
 It will create a virtual Modbus TCP device running at `localhost:5020`, and you can open a new terminal, poll the virtual device using *modpoll* tool,
@@ -197,7 +198,7 @@ modpoll \
 > Use `sudo` before the docker command if you want to use the standard port `502`.
 
 ```bash
-sudo docker run --rm -p 502:5020 helloysd/modsim
+sudo docker run --rm -p 502:5020 topmaker/modsim
 ```
 
 In a new terminal,
@@ -241,7 +242,7 @@ See [document](https://gavinying.github.io/modpoll/usage.html#Named%20Arguments)
 
 ### Write registers via MQTT publish
 
-The *modpoll* tool will subscribe to the topic `modpoll/<device_name>/set` by default once it successfully connected to MQTT broker, user can write device register(s) via MQTT publish,
+The *modpoll* tool will subscribe to the topic `modpoll/{{device_name}}/set` by default once it successfully connected to MQTT broker, user can write device register(s) via MQTT publish,
 
 - To write a single holding register (address at `40001`)
 
@@ -269,7 +270,7 @@ The *modpoll* tool will subscribe to the topic `modpoll/<device_name>/set` by de
 A docker image has been provided for user to directly run the tool without local installation,
 
   ```bash
-  docker run --rm helloysd/modpoll
+  docker run --rm topmaker/modpoll
   ```
 
 It shows the version of the tool by default.
@@ -277,7 +278,7 @@ It shows the version of the tool by default.
 Similar to the above *modsim* test, we can poll data with `docker run`, in order to avoid printing out received data, the argument `--daemon` or `-d` is recommended to use with docker.
 
   ```bash
-  docker run --rm helloysd/modpoll \
+  docker run --rm topmaker/modpoll \
     modpoll -d \
       --tcp modsim.topmaker.net \
       --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
@@ -287,7 +288,7 @@ If you want to load a local configure file, you need to mount a local folder ont
 for example, if the child folder `examples` contains the config file `modsim.csv`, we can use it via the following command,
 
   ```bash
-  docker run --rm -v $(pwd)/examples:/app/examples helloysd/modpoll \
+  docker run --rm -v $(pwd)/examples:/app/examples topmaker/modpoll \
     modpoll -d \
       --tcp modsim.topmaker.net \
       --config /app/examples/modsim.csv
@@ -340,8 +341,9 @@ for example, if the child folder `examples` contains the config file `modsim.csv
   ```
 
 
-> *Refer to the [documentation](https://gavinying.github.io/modpoll) site for more details about the configuration and examples.*
+> Refer to the [documentation](https://gavinying.github.io/modpoll) site for more details about the configuration and examples.
 
+> *If you find this tool useful, please support us by starring 🌟 our repository to encourage further improvements.*
 
 ## Credits
 

{modpoll-1.3.0 → modpoll-1.4.0}/README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/github/license/gavinying/modpoll)](https://img.shields.io/github/license/gavinying/modpoll)
 [![Downloads](https://static.pepy.tech/badge/modpoll/week)](https://pepy.tech/project/modpoll)
 
-Show your love for this project by starring our repo 🌟, so we are encouraged to continue improving.
+> 📢 **Announcement:** Since the release of v1.3.0, our official dockerhub namespace has been changed to `topmaker`, you can pull the latest images from [topmaker/modpoll](https://hub.docker.com/repository/docker/topmaker/modpoll) at dockerhub.
 
 > Learn more about *modpoll* usage at [documentation](https://gavinying.github.io/modpoll) site.
 
@@ -159,7 +159,7 @@ The configuration can be either a local file or a remote public URL resource.
 If you are blocked by company firewall for online device or prefer a local test, you can launch your own device simulator by running *modsim* locally,
 
 ```bash
-docker run --rm -p 5020:5020 helloysd/modsim
+docker run --rm -p 5020:5020 topmaker/modsim
 ```
 
 It will create a virtual Modbus TCP device running at `localhost:5020`, and you can open a new terminal, poll the virtual device using *modpoll* tool,
@@ -174,7 +174,7 @@ modpoll \
 > Use `sudo` before the docker command if you want to use the standard port `502`.
 
 ```bash
-sudo docker run --rm -p 502:5020 helloysd/modsim
+sudo docker run --rm -p 502:5020 topmaker/modsim
 ```
 
 In a new terminal,
@@ -218,7 +218,7 @@ See [document](https://gavinying.github.io/modpoll/usage.html#Named%20Arguments)
 
 ### Write registers via MQTT publish
 
-The *modpoll* tool will subscribe to the topic `modpoll/<device_name>/set` by default once it successfully connected to MQTT broker, user can write device register(s) via MQTT publish,
+The *modpoll* tool will subscribe to the topic `modpoll/{{device_name}}/set` by default once it successfully connected to MQTT broker, user can write device register(s) via MQTT publish,
 
 - To write a single holding register (address at `40001`)
 
@@ -246,7 +246,7 @@ The *modpoll* tool will subscribe to the topic `modpoll/<device_name>/set` by de
 A docker image has been provided for user to directly run the tool without local installation,
 
   ```bash
-  docker run --rm helloysd/modpoll
+  docker run --rm topmaker/modpoll
   ```
 
 It shows the version of the tool by default.
@@ -254,7 +254,7 @@ It shows the version of the tool by default.
 Similar to the above *modsim* test, we can poll data with `docker run`, in order to avoid printing out received data, the argument `--daemon` or `-d` is recommended to use with docker.
 
   ```bash
-  docker run --rm helloysd/modpoll \
+  docker run --rm topmaker/modpoll \
     modpoll -d \
       --tcp modsim.topmaker.net \
       --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
@@ -264,7 +264,7 @@ If you want to load a local configure file, you need to mount a local folder ont
 for example, if the child folder `examples` contains the config file `modsim.csv`, we can use it via the following command,
 
   ```bash
-  docker run --rm -v $(pwd)/examples:/app/examples helloysd/modpoll \
+  docker run --rm -v $(pwd)/examples:/app/examples topmaker/modpoll \
     modpoll -d \
       --tcp modsim.topmaker.net \
       --config /app/examples/modsim.csv
@@ -317,8 +317,9 @@ for example, if the child folder `examples` contains the config file `modsim.csv
   ```
 
 
-> *Refer to the [documentation](https://gavinying.github.io/modpoll) site for more details about the configuration and examples.*
+> Refer to the [documentation](https://gavinying.github.io/modpoll) site for more details about the configuration and examples.
 
+> *If you find this tool useful, please support us by starring 🌟 our repository to encourage further improvements.*
 
 ## Credits
 

{modpoll-1.3.0 → modpoll-1.4.0}/modpoll/arg_parser.py

@@ -39,8 +39,8 @@ def get_parser():
     parser.add_argument(
         "--interval",
         type=float,
-        default=1.0,
-        help="The time interval in seconds between two polling, Defaults to 1.0",
+        default=0.5,
+        help="The time interval in seconds between two polling, Defaults to 0.5",
     )
     parser.add_argument(
         "--tcp", help="Act as a Modbus TCP master, connecting to host TCP"
@@ -108,8 +108,8 @@ def get_parser():
     )
     parser.add_argument(
         "--mqtt-publish-topic-pattern",
-        default="modpoll/<device_name>/data",
-        help='Topic pattern for MQTT publish. Use <device_name> as placeholder for the device names in Modbus config. Defaults to "modpoll/<device_name>"',
+        default="modpoll/{{device_name}}/data",
+        help='Topic pattern for MQTT publish. Use {{device_name}} as placeholder for the device names in Modbus config. Defaults to "modpoll/{{device_name}}/data"',
     )
     parser.add_argument(
         "--mqtt-subscribe-topic-pattern",
@@ -118,8 +118,8 @@ def get_parser():
     )
     parser.add_argument(
         "--mqtt-diagnostics-topic-pattern",
-        default="modpoll/<device_name>/diagnostics",
-        help="Topic pattern for MQTT diagnostics. Use <device_name> as placeholder for the device names in Modbus config. Defaults to modpoll/<device_name>/diagnostics",
+        default="modpoll/{{device_name}}/diagnostics",
+        help="Topic pattern for MQTT diagnostics. Use {{device_name}} as placeholder for the device names in Modbus config. Defaults to modpoll/{{device_name}}/diagnostics",
     )
     parser.add_argument(
         "--mqtt-qos",

{modpoll-1.3.0 → modpoll-1.4.0}/modpoll/main.py

@@ -51,7 +51,7 @@ def app(name="modpoll"):
         )
         if args.mqtt_topic_prefix.endswith("/"):
             args.mqtt_topic_prefix = args.mqtt_topic_prefix[:-1]
-        args.mqtt_publish_topic_pattern = f"{args.mqtt_topic_prefix}/<device_name>"
+        args.mqtt_publish_topic_pattern = f"{args.mqtt_topic_prefix}/{{device_name}}"
         args.mqtt_subscribe_topic_pattern = f"{args.mqtt_topic_prefix}/#/set"
 
     # setup mqtt

{modpoll-1.3.0 → modpoll-1.4.0}/modpoll/modbus_task.py

@@ -264,10 +264,11 @@ class ModbusHandler:
         config_file: str,
         mqtt_handler: Optional[MqttHandler] = None,
         timeout: float = 3.0,
-        interval: float = 1.0,
+        interval: float = 0.5,
         daemon: bool = False,
         mqtt_publish_topic_pattern: Optional[str] = None,
         mqtt_diagnostics_topic_pattern: Optional[str] = None,
+        mqtt_single_publish: bool = False,
     ):
         self.modbus_client = modbus_client
         self.config_file = config_file
@@ -277,6 +278,7 @@ class ModbusHandler:
         self.daemon = daemon
         self.mqtt_publish_topic_pattern = mqtt_publish_topic_pattern
         self.mqtt_diagnostics_topic_pattern = mqtt_diagnostics_topic_pattern
+        self.mqtt_single_publish = mqtt_single_publish
         self.connected = False
         self.deviceList: List[Device] = []
         self.logger = logging.getLogger(__name__)
@@ -319,7 +321,7 @@ class ModbusHandler:
                         continue
                     device_name = row[1].strip()
                     try:
-                        device_id = int(row[2])
+                        device_id = int(row[2], 0)
                     except ValueError:
                         self.logger.error(f"Invalid device ID for {device_name}")
                         continue
@@ -357,8 +359,8 @@ class ModbusHandler:
             return None
         fc = row[1].lower()
         try:
-            start_address = int(row[2])
-            size = int(row[3])
+            start_address = int(row[2], 0)
+            size = int(row[3], 0)
         except ValueError:
             self.logger.error("Invalid start address or size for poller")
             return None
@@ -401,7 +403,7 @@ class ModbusHandler:
             return None
         ref_name = row[1].replace(" ", "_")
         try:
-            address = int(row[2])
+            address = int(row[2], 0)
         except ValueError:
             self.logger.error(f"Invalid address for reference {ref_name}")
             return None
@@ -507,25 +509,40 @@ class ModbusHandler:
             print(table)
 
     def publish_data(self, timestamp=None, on_change=False):
-        if not self.mqtt_handler:
-            return
-        if not self.mqtt_publish_topic_pattern:
+        if not self.mqtt_handler or not self.mqtt_publish_topic_pattern:
             return
+
         for dev in self.deviceList:
+            if not dev.pollSuccess:
+                self.logger.debug(
+                    f"Skip publishing for disconnected device: {dev.name}"
+                )
+                continue
+
             payload = {}
             for ref in dev.references.values():
                 if not on_change or ref.val != ref.last_val:
-                    value = (
+                    ref_val = (
                         round(ref.val, FLOAT_TYPE_PRECISION)
                         if isinstance(ref.val, float)
                         else ref.val
                     )
-                    payload[ref.name] = value
-            if payload:
-                if timestamp:
+                    key = f"{ref.name}|{ref.unit}" if ref.unit else ref.name
+                    payload[key] = ref_val
+
+                    if self.mqtt_single_publish:
+                        topic = f"{self.mqtt_publish_topic_pattern.replace('{{device_name}}', dev.name)}/{ref.name}"
+                        if isinstance(ref_val, list):
+                            for i, entry in enumerate(ref_val):
+                                self.mqtt_handler.publish(f"{topic}/{i}", entry)
+                        else:
+                            self.mqtt_handler.publish(topic, ref_val)
+
+            if payload and not self.mqtt_single_publish:
+                if timestamp is not None:
                     payload["timestamp"] = timestamp
                 topic = self.mqtt_publish_topic_pattern.replace(
-                    "<device_name>", dev.name
+                    "{{device_name}}", dev.name
                 )
                 self.mqtt_handler.publish(topic, json.dumps(payload))
 
@@ -541,7 +558,7 @@ class ModbusHandler:
                 "last_poll_success": dev.pollSuccess,
             }
             topic = self.mqtt_diagnostics_topic_pattern.replace(
-                "<device_name>", dev.name
+                "{{device_name}}", dev.name
             )
             self.mqtt_handler.publish(topic, json.dumps(payload))
 
@@ -581,6 +598,7 @@ def setup_modbus_handlers(args, mqtt_handler: Optional[MqttHandler] = None):
             daemon=args.daemon,
             mqtt_publish_topic_pattern=args.mqtt_publish_topic_pattern,
             mqtt_diagnostics_topic_pattern=args.mqtt_diagnostics_topic_pattern,
+            mqtt_single_publish=args.mqtt_single,
         )
         if modbus_handler.load_config():
             modbus_handlers.append(modbus_handler)

{modpoll-1.3.0 → modpoll-1.4.0}/modpoll/mqtt_task.py

@@ -197,11 +197,14 @@ class MqttHandler:
             return False
 
     def publish(
-        self, topic: str, msg: str, qos: int = 0, retain: bool = False
+        self, topic: str, msg: str, qos: Optional[int] = None, retain: bool = False
     ) -> Optional[MQTTMessageInfo]:
         if not self.mqtt_client:
             self.logger.error("MQTT client not initialized. Call setup() first.")
             return None
+
+        qos = self.qos if qos is None else qos
+
         if not self.mqtt_client.is_connected():
             if qos == 0:
                 self.logger.warning(

{modpoll-1.3.0 → modpoll-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "modpoll"
-version = "v1.3.0"
+version = "v1.4.0"
 description = "A New Command-line Tool for Modbus and MQTT"
 authors = ["Ying Shaodong <helloysd@gmail.com>"]
 repository = "https://github.com/gavinying/modpoll"