docs: finalize cross-platform support and portability guide

- Updated README.md with comprehensive installation and usage guides.
- Added cross-platform command comparison table (Linux vs Windows).
- Included portability instructions for USB drive execution.
- Verified stable operation on Windows 10/11 (CMD/PowerShell) and Linux (Ubuntu/LMDE 7).
- Synchronized default paths and fixed toggle command examples
This commit is contained in:
2026-04-10 16:26:20 +03:00
parent d6e9ac13d1
commit a7707aff4b
2 changed files with 35 additions and 33 deletions
+34 -32
View File
@@ -7,9 +7,10 @@ Designed for stability in production environments where reliability is key.
### 📋 Features ### 📋 Features
* **Direct Socket Communication:** No heavy libraries like `pymodbus` required. * **Direct Socket Communication:** No heavy libraries like `pymodbus` required.
* **Instance Protection:** Uses `fcntl` file locking to prevent race conditions during concurrent executions. * **Cross-Platform:** Full support for `Linux` and `Windows`.
* **Health Checks:** Integrated `ICMP` ping check before command execution. * **Health Checks:** Integrated `ICMP` ping check before command execution.
* **Configurable:** All parameters (IP, Port, Channels) are stored in an external `.ini` file. * **Configurable:** All parameters (IP, Port, Channels) are stored in an external `.ini` file.
* **Smart Paths:** Uses `pathlib` for automatic directory creation (e.g., `logs/` folder).
* **Detailed Logging:** Full audit trail of all `ON/OFF/TOGGLE` actions. * **Detailed Logging:** Full audit trail of all `ON/OFF/TOGGLE` actions.
--- ---
@@ -17,9 +18,8 @@ Designed for stability in production environments where reliability is key.
### 💻 Requirements ### 💻 Requirements
| Requirement | Value | | Requirement | Value |
| :--- | :--- | | :--- | :--- |
| **OS** | Linux (Ubuntu, Debian, LMDE, etc.) | | **OS** | Linux, Windows, FreeBSD |
| **Python** | 3.6+ | | **Python** | 3.6+ (standard library only) |
| **Permissions** | Write access to log/lock paths |
--- ---
@@ -32,56 +32,58 @@ Designed for stability in production environments where reliability is key.
| **`[modbus]`** | `coil_base` | Channel base num (`0` or `1`) | `1` | | **`[modbus]`** | `coil_base` | Channel base num (`0` or `1`) | `1` |
| **`[modbus]`** | `timeout` | Socket timeout (sec) (only view) | `1` | | **`[modbus]`** | `timeout` | Socket timeout (sec) (only view) | `1` |
| **`[modbus]`** | `max_channel`| Max channel index (e.g., `7`). `7` for `coil_base=1` too. | `7` | | **`[modbus]`** | `max_channel`| Max channel index (e.g., `7`). `7` for `coil_base=1` too. | `7` |
| **`[paths]`** | `lock_file` | Path to `.lock` file | `/tmp/modbus.lock` | | **`[paths]`** | `lock_file` | Path to `.lock` file | `modbus.lock` |
| **`[paths]`** | `log_file` | Path to `.log` file | `/tmp/modbus.log` | | **`[paths]`** | `log_file` | Path to `.log` file | `logs/modbus.log` |
**Tip**: It's better to specify relative names in default path values,
so that they work "out of the box" everywhere:
--- ---
### ⚙️ Installation & Setup ### ⚙️ Installation & Portability
The tool is fully portable and can be run directly from a USB drive or any local folder without system-wide installation.
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/andsyrovatko/s4k-modbus-relay-controller.git git clone https://github.com/andsyrovatko/s4k-modbus-relay-controller.git
cd s4k-modbus-relay-controller cd s4k-modbus-relay-controller
``` ```
2. Configure the tool: 2. Configure the tool:
Copy the example config and edit it with your device details: Copy the example config and edit it (the script will automatically find it in its own directory):
* `Linux:`
```bash ```bash
cp config.ini.example config.ini cp config.ini.example config.ini && nano config.ini
nano config.ini
``` ```
3. Set executable permissions: * `Windows:`
```bash
copy config.ini.example config.ini
```
(then edit with any text editor)
3. Permissions (`Linux only`):
```bash ```bash
chmod +x modbus_controller.py chmod +x modbus_controller.py
``` ```
(to start script as `./modbus_controller.py` not `python modbus_controller.py`)
--- ---
### 🚀 Usage ### 🚀 Usage
0. Use via cli or call from another soft: The script supports both Windows and Linux syntax. You can run it from any location by specifying the full path.
```bash | Action | Linux | Windows (CMD/PowerShell) | Result |
# Get script help/usage info | :--- | :--- | :--- | :--- |
python3 modbus_controller.py | **Get Status** | `./modbus_controller.py status 1` | `python modbus_controller.py status 1` | Channel 1 is OFF |
# Output: modbus_controller.py <status|on|off|toggle> <channel> | **Turn ON** | `./modbus_controller.py on 1` | `python modbus_controller.py on 1` | Channel 1 is turned ON |
| **Turn OFF** | `./modbus_controller.py off 1` | `python modbus_controller.py off 1` | Channel 1 is turned OFF |
| **Toggle** | `./modbus_controller.py toggle 1` | `python modbus_controller.py toggle 1` | Channel 1 is turned OFF (if was ON) |
# Get channel status ### 📦 Portable Example (Windows)
python3 modbus_controller.py status 8 Run the script directly from your USB drive (e.g. `F:\`) by specifying the full path:
# Output: Channel 8 is OFF ```powershell
python F:\ModBus\modbus_controller.py status 1
# Turn a specific channel ON or OFF ```
python3 modbus_controller.py on 8
# Output: Channel 8 is turned ON
# Toggle channel state
python3 modbus_controller.py toggle 8
# Output: Channel 8 is turned ON
```
--- ---
### ⚠️ Important Note ### [✓] Verified: Tested on Linux (LMDE 7) and Windows 11.
[**!IMPORTANT**]\
This version currently supports Linux only due to the use of fcntl for process locking. Windows support is planned for future releases.
--- ---
Regular → Executable
+1 -1
View File
@@ -4,7 +4,7 @@
# Description : Control Modbus coils via TCP (Modbus RTU over TCP). # Description : Control Modbus coils via TCP (Modbus RTU over TCP).
# Usage : python3 modbus_controller.py <status|on|off|toggle> <channel> # Usage : python3 modbus_controller.py <status|on|off|toggle> <channel>
# Author : syr4ok (Andrii Syrovatko) # Author : syr4ok (Andrii Syrovatko)
# Version : 1.1.0b # Version : 1.1.0
# ============================================================================= # =============================================================================
import configparser import configparser
import os import os