mirror of
https://github.com/andsyrovatko/s4k-modbus-relay-controller.git
synced 2026-04-21 22:08:54 +02:00
refactor: make modbus controller cross-platform and improve locking
- Added cross-platform file locking using msvcrt (Windows) and fcntl (Unix). - Switched to pathlib for robust path management and automatic directory creation. - Updated is_host_reachable to support Windows ping syntax. - Added atexit handler to ensure lock file descriptors are closed properly. NOTE: Verified on Linux (LMDE 7). Windows compatibility implemented but not yet tested.
This commit is contained in:
@@ -217,6 +217,8 @@ __marimo__/
|
|||||||
|
|
||||||
# Manual additions
|
# Manual additions
|
||||||
*.ini
|
*.ini
|
||||||
|
*.lock
|
||||||
|
*.log
|
||||||
|
|
||||||
# Project files, i.e. `.project`, `.actionScriptProperties` and `.flexProperties`
|
# Project files, i.e. `.project`, `.actionScriptProperties` and `.flexProperties`
|
||||||
# should NOT be excluded as they contain compiler settings and other important
|
# should NOT be excluded as they contain compiler settings and other important
|
||||||
|
|||||||
+2
-2
@@ -7,5 +7,5 @@ timeout = 1 # Timeout value in seconds
|
|||||||
max_channel = 7 # Maximum number of channels of the Modbus device model (7 - 0-7, as 8 channels summary)
|
max_channel = 7 # Maximum number of channels of the Modbus device model (7 - 0-7, as 8 channels summary)
|
||||||
|
|
||||||
[paths]
|
[paths]
|
||||||
lock_file = /tmp/modbus_controller.lock
|
lock_file = modbus_controller.lock
|
||||||
log_file = /tmp/modbus_controller.log
|
log_file = modbus_logs/modbus_controller.log
|
||||||
|
|||||||
+48
-22
@@ -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.0.0-linux
|
# Version : 1.1.0b
|
||||||
# =============================================================================
|
# =============================================================================
|
||||||
import configparser
|
import configparser
|
||||||
import os
|
import os
|
||||||
@@ -13,7 +13,8 @@ import sys
|
|||||||
import time
|
import time
|
||||||
import subprocess
|
import subprocess
|
||||||
import logging
|
import logging
|
||||||
import fcntl
|
from pathlib import Path
|
||||||
|
import atexit
|
||||||
|
|
||||||
# Read configuration (variables will be used later in the code)
|
# Read configuration (variables will be used later in the code)
|
||||||
config = configparser.ConfigParser(inline_comment_prefixes=('#', ';'))
|
config = configparser.ConfigParser(inline_comment_prefixes=('#', ';'))
|
||||||
@@ -28,36 +29,60 @@ COIL_BASE = config.getint('modbus', 'coil_base')
|
|||||||
TIMEOUT = config.getint('modbus', 'timeout')
|
TIMEOUT = config.getint('modbus', 'timeout')
|
||||||
MAX_CHANNEL = config.getint('modbus', 'max_channel')
|
MAX_CHANNEL = config.getint('modbus', 'max_channel')
|
||||||
|
|
||||||
LOCK_FILE = config.get('paths', 'lock_file')
|
# We get the path to the folder where the script is located
|
||||||
LOG_FILE = config.get('paths', 'log_file')
|
BASE_DIR = Path(__file__).parent.resolve()
|
||||||
|
|
||||||
log_dir = os.path.dirname(LOG_FILE)
|
# You can read values in the config, and if they are empty or relative, process them:
|
||||||
if not os.path.exists(log_dir):
|
def get_path(config_value, default_name):
|
||||||
|
path = Path(config_value)
|
||||||
|
return path if path.is_absolute() else BASE_DIR / path
|
||||||
|
|
||||||
|
LOG_FILE = get_path(config.get('paths', 'log_file'), "modbus.log")
|
||||||
|
LOCK_FILE = get_path(config.get('paths', 'lock_file'), "modbus.lock")
|
||||||
|
|
||||||
|
# Creating a folder for logs (works on both OSes)
|
||||||
|
LOG_FILE.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
LOCK_FILE.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
# Locker init
|
||||||
|
lock_fp = None
|
||||||
|
def acquire_lock(lock_file):
|
||||||
|
global lock_fp
|
||||||
try:
|
try:
|
||||||
os.makedirs(log_dir, exist_ok=True)
|
lock_fp = open(lock_file, 'w')
|
||||||
except OSError as e:
|
if sys.platform == 'win32':
|
||||||
print(f"Error: Cannot create log directory {log_dir}: {e}")
|
import msvcrt
|
||||||
# Use local log file as instead
|
msvcrt.locking(lock_fp.fileno(), msvcrt.LK_NBLCK, 1)
|
||||||
LOG_FILE = "modbus_controller.log"
|
else:
|
||||||
|
import fcntl
|
||||||
|
fcntl.flock(lock_fp, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
||||||
|
atexit.register(lock_fp.close) # Close when leaving
|
||||||
|
return True
|
||||||
|
except (OSError, IOError, BlockingIOError):
|
||||||
|
return False
|
||||||
|
|
||||||
|
if not acquire_lock(LOCK_FILE):
|
||||||
|
print("Another instance is already running.")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
# -------- LOCK TEST ----------
|
||||||
|
# print("Lock acquired! Sleeping for 20 seconds... Quick! Run another instance!")
|
||||||
|
# time.sleep(20)
|
||||||
|
# -----------------------------
|
||||||
|
|
||||||
logging.basicConfig(
|
logging.basicConfig(
|
||||||
filename=LOG_FILE,
|
filename=str(LOG_FILE),
|
||||||
level=logging.INFO,
|
level=logging.INFO,
|
||||||
format="%(asctime)s - %(levelname)s - %(message)s",
|
format="%(asctime)s - %(levelname)s - %(message)s",
|
||||||
datefmt="%Y-%m-%d at %H:%M:%S"
|
datefmt="%Y-%m-%d at %H:%M:%S"
|
||||||
)
|
)
|
||||||
|
|
||||||
lock_fp = open(LOCK_FILE, "w")
|
|
||||||
try:
|
|
||||||
fcntl.flock(lock_fp, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
|
||||||
except BlockingIOError:
|
|
||||||
print("Another instance is already running.")
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
def is_host_reachable(host):
|
def is_host_reachable(host):
|
||||||
|
# Determine the ping parameter based on the operating system
|
||||||
|
param = "-n" if sys.platform.lower() == "win32" else "-c"
|
||||||
try:
|
try:
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["ping", "-c", "1", "-W", "1", host],
|
["ping", param, "1", "-w", "1000", host],
|
||||||
stdout=subprocess.DEVNULL,
|
stdout=subprocess.DEVNULL,
|
||||||
stderr=subprocess.DEVNULL
|
stderr=subprocess.DEVNULL
|
||||||
)
|
)
|
||||||
@@ -135,11 +160,11 @@ if len(sys.argv) != 3:
|
|||||||
command_input = sys.argv[1].lower()
|
command_input = sys.argv[1].lower()
|
||||||
channel_input = sys.argv[2]
|
channel_input = sys.argv[2]
|
||||||
|
|
||||||
# Converting ON/OFF into a command
|
# Accepting "ON"/"OFF" as commands
|
||||||
if command_input in ['on', 'off', 'toggle', 'status']:
|
if command_input in ['on', 'off', 'toggle', 'status']:
|
||||||
command = command_input
|
command = command_input
|
||||||
else:
|
else:
|
||||||
# Attempt to accept "ON"/"OFF" as a command
|
# Try to accept "ON"/"OFF" in any case as well
|
||||||
if command_input.upper() == 'ON':
|
if command_input.upper() == 'ON':
|
||||||
command = 'on'
|
command = 'on'
|
||||||
elif command_input.upper() == 'OFF':
|
elif command_input.upper() == 'OFF':
|
||||||
@@ -211,3 +236,4 @@ except (socket.timeout, ConnectionRefusedError, OSError) as e:
|
|||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
sys.exit(0)
|
sys.exit(0)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user