smithtek-mako-rf 2.9.1 → 2.9.3

package/README.md

@@ -338,6 +338,74 @@ The (try x/y) indicator shows retry behaviour. For example try 2/3 means the fir
 
 If you see repeated red failures on a single device, it usually points to ID/address mismatch, wiring/RF link quality, or the poll rate being too aggressive for the link.
 
+
+---
+## RSSI (RF Signal Strength Diagnostic) ##
+
+RSSI (Received Signal Strength Indicator) provides a live measurement of the RF signal strength between the PassPort and the remote Mako device when using the RF channel.
+
+When enabled, the node performs an additional request to the LoRa module after each successful Modbus read. The returned signal strength (in dBm) is then appended to the output payload.
+
+This allows you to:
+- Verify RF link quality during installation
+- Diagnose weak or marginal radio paths
+- Confirm antenna alignment and placement
+- Monitor signal health during maintenance
+How to Enable
+- Open the Bus configuration node (smithtek-mako-rf-bus).
+- Select the RF channel.
+- Tick the RSSI checkbox.
+- Deploy.
+- To disable RSSI, simply untick the checkbox and deploy again.
+
+
+## RSSI Output Behaviour (msg.payload) ##
+
+When enabled:
+RSSI is appended to the normal decoded payload (msg.payload).
+It is added to the same JSON object generated by the Decoder map.
+The property name is automatically derived from the node block name.
+
+`RSSI Guard & Timeout Settings`
+
+The RSSI feature includes two adjustable timing parameters to fine-tune how the LoRa module is queried after a Modbus poll.
+In most installations.
+`The default values (10ms guard / 100ms timeout) are ideal and do not require adjustment.
+
+`RSSI Guard (ms)`
+
+The RSSI Guard is the delay between the completed Modbus response and the RSSI request being sent to the LoRa module.
+- This short pause ensures:
+- The Modbus transaction has fully completed
+- The UART buffer has settled
+- The RF module is ready to respond cleanly
+
+Typical range: 5–10ms
+Default: 10ms
+
+Lower values may work, but 10ms provides stable behaviour across most installations.
+
+`RSSI Timeout (ms)`
+
+The RSSI Timeout defines how long the system will wait for the LoRa module to respond with the RSSI value before aborting the request.
+Default: 100ms
+
+This is usually more than sufficient. Increasing the timeout:
+Does not improve signal strength
+Only increases the wait time if the module does not respond
+The timeout should only be increased if diagnosing unusual behaviour on a slow or noisy link.
+
+## RSSI Practical Guidance ##
+
+- Leave both values at default unless diagnosing an issue.
+- Use RSSI primarily during install or maintenance.
+- If RSSI is enabled permanently, keep guard low and timeout reasonable to avoid unnecessary bus slowdown.
+
+In short, the defaults are tuned for real-world PassPort + Mako RF deployments and will suit almost every scenario.
+
+![SmithTek Control](https://github.com/smithtekIOT/ArtWork/blob/master/RSSI%20switch.png?raw=true)
+
+
 ---
 ## Polling Tips – Long Range RF ##
 
@@ -410,7 +478,7 @@ Example:
 
 - 1024 → use table values
 
-- 2 048 → add ~2 seconds to the recommended inject interval
+- 2- 048 → add ~2 seconds to the recommended inject interval
 
 - 4096 → add ~4 seconds to the recommended inject interval
 
@@ -427,18 +495,24 @@ In RF systems, range and stability always win over speed.
 | Red status: timeout | Polling too fast | Increase inject interval (slow the cycle time) |
 | Red status: timeout | RF link marginal | Increase spreading factor or improve antenna alignment |
 | Red status: timeout | Inject interval shorter than cycle time | Ensure inject interval is longer than full device cycle |
+| Red status: timeout after working normally | Bus overloaded | Reduce number of devices per cycle or increase interval |
 | Only first and last device polling | Queue dropping logic enabled | Disable aggressive queue dropping or increase maxQueue |
 | Devices poll intermittently | Retries too high | Reduce retries to prevent blocking the queue |
+| Devices stop polling after deploy | Serial port locked | Restart Node-RED or power cycle PassPort |
 | Data values incorrect | Register order mismatch | Ensure V-NET Modbus table matches Node-RED decoder map exactly |
 | 32-bit values incorrect | Wrong word order | Confirm correct 32-bit interpretation (float / unsigned / integer) |
 | Digital bits incorrect | Bit index mismatch | Ensure correct bit number (0–15) selected in decoder |
 | Write command not working | Wrong function code | Confirm FC5 for coil, FC6 for single register, FC15/16 for multiples |
 | Write works but value wrong | Payload type mismatch | Ensure msg.payload is correct type (bool or number) |
+| Write command appears successful but nothing changes | Writing to wrong register type | Confirm coil vs holding register mapping in V-NET |
 | Queue growing continuously | Inject too fast | Increase inject interval |
 | Random comms drops on RF | Spreading factor too low for range | Increase spreading factor (add time to cycle) |
+| RF very slow but stable | High spreading factor | Increase inject interval accordingly |
+| Works on RS485 but not RF | Wrong Bus selected | Confirm correct Bus channel assigned |
 | RS485 unstable | Wiring issue | Check termination resistors and polarity (A/B swapped) |
+| All devices fail at once | Bus configuration changed | Confirm baud rate, parity, stop bits match |
 | Node shows “bus config missing” | Config node deleted | Reassign or recreate the Bus config |
-| Node invisible / unknown type | HTML/JS syntax error | Contact Smithtek Support |
+| Node invisible / unknown type | HTML/JS syntax error | Check node installtion, reinstall or contact smithtek support |
 
 ## Golden Rule
 
@@ -450,6 +524,12 @@ If the inject interval is shorter than the cycle time, the queue will grow, time
 
 Slow and stable always beats fast and failing.
 
+
+
+
+
+
+
 ---
 # License
 Copyright (c) 2023 www.smithtek.com.au Licenced under the terms of the GPLv3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smithtek-mako-rf",
-  "version": "2.9.1",
+  "version": "2.9.3",
   "description": "Smithtek dedicated node for communicating with the Mako PLC over RS485 or RF",
   "keywords": [
     "node-red",