SFW002 - Changelist (ORB Gen 2 OS)

Before upgrading: please read all release notes between the existing version and new version for any breaking changes.

Note

Firmware marked [DEVELOPMENT] includes the latest features but may not be fully tested. Use with caution for in-field deployments.

SFW002-4.2.0 `[LATEST]`

Release Date: 2024/11/19

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

CAN: disable CANFD mode by default to improve compatibility with some CAN devices.
SCRIPT: Add new function SQ.portal_connected() to check if the device is connected to the Senquip Portal.
SCRIPT: Increase exception max length from 80 to 120 characters.
BUFFER: Fix a bug where the buffered messages would be sent very slowly to Senquip Portal if ‘Use Senquip Data Format’ is unticked.

SFW002-4.1.0

Release Date: 2024/10/15

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

CURRENT: fix an issue where the current measurement could fail for the first cycle after boot.
SCRIPT: Add new built-in function ‘isdef’ that returns false if a variable is null or undefined. Example use: let x; if (isdef(x)) { ... }
DIAGNOSTICS: Add task errors to diagnostics message.

SFW002-4.0.0

Release Date: 2024/08/28

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Breaking Changes:

BLUETOOTH: The Bluetooth module is now disabled by default to increase the available memory for other features. To enable Bluetooth from the Senquip Portal, go to Settings –> Internal –> Bluetooth and tick ‘Enable Bluetooth’.

Changes:

BLUETOOTH: stop scanning for BLE devices if a firmware update is in progress.
SERIAL: improve the serial data handler in scripting to achieve 250ms response time.
SYSTEM: increase stack size to improve stability.
LTE: improvements to modem initialisation & band selection. Allow locking to a specific operator/carrier (if required).
SCRIPT: recovery if a script fails to load or crashes during startup.
SYSTEM: longer delay before rebooting after firmware update to ensure success message is sent.
MQTT: collect diagnostics on MQTT Ack delays.

SFW002-3.2.1

Release Date: 2024/08/13

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

CAN: bug fix for repeated CAN TX message slots from script.

CAN: fix ‘Can Module Error’ if the CAN scan time was equal/greater than base interval.

SYSTEM: improved system recovery if CAN module gets stuck in a bad state.

SFW002-3.2.0

Release Date: 2024/08/06

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

LED: add a new LED mode to indicate when the device has a network connection and an IP address, but cannot establish a connection to the Senquip Portal. The orange LED will be on, with a quick off every two seconds.

BLUETOOTH: fix a bug stopping BLE data collection on the first cycle, if a filter list was set.

MAGNET: fix an issue causing excessive magnetic sensor interrupts if BLE scan was enabled. This could increase the time taken for the device to establish a network connection (when BLE scan enabled).

SFW002-3.1.2

Release Date: 2024/06/04

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

HIBERNATE: improve power draw in hibernate mode if Wifi AP setting is enabled.

SFW002-3.1.1

Release Date: 2024/05/30

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

WEB SERVER: limit the maximum number of incoming connections to the device’s web server to avoid running out of memory.

SFW002-3.1.0

Release Date: 2024/05/29

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

MAGNET: improve power draw in sleep when Magnetic Sensor is enabled.

SLEEP: report reason for wake from sleep/hibernate (Magnetic Sensor, Tamper, Vibration, IO Change). These wake sources will reset the hibernate delay.

CAN: allow up to 8 slots for repeated CAN messages to be sent automatically. See CAN.tx() function in the scripting guide for more info.

WIFI AP: Wifi AP mode can be enabled outside of Setup Mode to allow connections to Wifi sensors.

PULSE: add pulse_deltaX keys to script data handler to report pulse count changes since last cycle. Note: these value are not reported to the Portal.

HOURMETER: add 10 custom hourmeters that can be updated from the script to track custom usage. See scripting guide for more info.

SHUTDOWN: fix bug where shutdown message would sometimes not be sent before the device powered off.

SCRIPT: allow up to 2000 characters in a script dispatch parameter. This feature is designed to aid developement and a fair use policy applies - excessive data use is monitored.

MAGNET: fix repeated triggers when using the Magnetic Sensor in ‘Trigger’ mode.

SCRIPT: bug fix for HTTP.query() when using a custom CA cert.

SETTINGS: bug fix for settings changes not being applied properly from Portal in some conditions.

DIAGNOSTICS: add Wifi MAC address to diagnostics message.

SNTP: use a default SNTP server if no server is provided in the settings.

GPS: bug fix for GPS.get_data() on ORB-C1-H.

Includes changes from previous beta versions.

SFW002-3.0.0-beta `[DEVELOPMENT]`

Release Date: 2024/02/29

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

PULSE COUNT: make the pulse count value non-volatile (saved to FLASH between reboots).

FIRMWARE UPDATE: now sends update progress to Portal. Fix bug if update was already in progress and a new one was triggered.

SETUP MODE: device will stay in setup mode after rebooting to apply new settings.

BUFFER: fix an issue with buffered/batched messages not sending to Portal if device did not remain awake long enough.

SCRIPT: add SQ.modbus_read() helper function.

SCRIPT: add GPS.fix() function to fix the GPS location to given co-ordinates.

SCRIPT: add SERIAL.IMMEDIATE flag as an optional parameter of SERIAL.write() to write immediately.

SCRIPT: allow SQ.dispatch() to be used anytime, not just from data handler.

GPS: add a watchdog to reset GPS module if GPS data is not received after a period of time.

SERIAL: add a setting to hold Current Source on if there is a serial/modbus device being powered from it. [External –> Serial 1 –> Powered by Current Source]

BLUETOOTH: ability to set network settings in Setup Mode using the Senquip Connect app v2+

BLUETOOTH: ability to send common data types to be displayed on the Senquip Connect app. See scripting guide for more info.

HTTP POST: reduce time and memory resources required for each HTTP Post request. Add a scripting function HTTP.post_active_count() to get the number of active connections.

REMOTE DATA: fix a memory leak when using SQ.req_remote_data() from script

SETTINGS: small increase to the time allowed to acknowledge a settings change from Portal

SCRIPT: fix an issue where sending data to endpoints from a script at a high rate could prevent the device from shutting down or hibernating

SFW002-2.6.4

Release Date: 2024/01/12

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

MODBUS: Fix a timing issue where there was no enough delay between successive reads from slave devices. This could cause every second channel (eg: 3, 5, 7..) to fail under certain conditions.

SFW002-2.6.2

Release Date: 2024/01/08

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

AA BATTERIES: Fix a race condition where AA Batteries would not be properly enabled after first power on.

SFW002-2.6.1

Release Date: 2023/11/27

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

PASSWORD: Fix issue where the filesystem could become corrupted after changing the password using the device’s local webserver.

ALERTS: Change ‘Hibernate Alert’ event severity from Alert to Info. This avoids triggering a Portal alert every time the device goes into Hibernate mode. If a Portal alert is required, use the ‘Power Loss Alert’ instead.

SFW002-2.6.0

Release Date: 2023/09/23

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

MODBUS: Increase the number of Modbus channels to 50. Parse slave response as it arrives, rather than at end of slave timeout.

DIAGNOSTICS: fix an issue with the diagnostics message buffer.

SFW002-2.5.1

Release Date: 2023/08/21

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

NETWORK: Increase the wait time when messages are transmitted before sleeping. On LTE networks with poor signal it can take up to 40 seconds for a message to be acknowledged by the server.

SFW002-2.5.0

Release Date: 2023/08/16

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

HIBERNATE: critical bug fixes for hibernate mode.

WEB: update device’s local web settings page.

AMBIENT: fix missing ambient temperature measurement on HW Rev 3

Warning

Firmware versions below this line have known issues that affect the long term stability of the device.

SFW002-2.4.0

Release Date: 2023/08/08

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

WATCHDOG: added a sleep/hibernate watchdog to reset the device if it does not wake from an extended sleep.

WATCHDOG: add watchdog if LTE or Wifi connects but does not properly obtain an IP address.

WATCHDOG: add watchdog if LTE connects but cannot send or receive data.

SYSTEM: add an event to the data message when device is in Setup Mode.

OTA: increase firmware update timeout to 1 hour for areas with poor LTE signal.

FILESYSTEM: fix an issue where the filesystem would sometimes not be unmounted before sleeping.

LTE: an update to LTE negotiation to use the DNS server provided by mobile network.

LTE: improve disconnection procedure from mobile network if an error occurs.

NETWORK: always show the last known Wifi or LTE RSSI value, even if the current value is not available.

DIAGNOSTICS: add the last device time sync source (SNTP, LTE or GPS) to diagnostics message.

MODBUS: add functions to read 64-bit double precision numbers from a slave.

MAGNET: device will stay in setup mode for 5 minutes if enabled and triggered using magnetic sensor.

SFW002-2.3.0

Release Date: 2023/07/11

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

WATCHDOG: rewrite connection watchdog to monitor endpoints and reset the device after a period of no connection.

MQTT: force immediate retry MQTT endpoint when IP address acquired.

DIAGNOSTICS: diagnostics messages are now buffered while offline or connecting.

SFW002-2.2.0

Release Date: 2023/06/30

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

SCRIPT: increase the number of Custom Settings from 5 to 10.

MAGNET: add an ‘All’ mode to perform wake, setup and trigger actions.

POWER: fix issue where device would retry forever and not go to sleep if HTTP endpoint failed to connect.

ENDPOINT: make connection status for endpoints (UDP, HTTP, MQTT) available in diagnostics.

CURRENT: increase resolution of current measurement. Max measurable current is 40 mA.

SFW002-2.1.0

Release Date: 2023/06/27

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

SCRIPT: add SQ.hourmeter_update() function to directly set state and hour counts.

SCRIPT: add HTTP.query() function to send an advanced GET or POST request.

SFW002-2.0.0

Release Date: 2023/05/12

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

POWER: fix bugs, improve & streamline System Shutdown/Hibernate process.

POWER: change System Shutdown threshold to Vsys < 3.6 Volts.

POWER: fix rare bugs with AA Batteries disable/enable logic.

MQTT: fix graceful disconnect when shutting down or rebooting.

SFW002-1.0.0

Release Date: 2023/04/27

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

AA BATTERIES: reduce current draw from AA batteries to extend life. AA Recharge threshold changed to Vsys < 3.7 Volts

POWER: fixed a bug which resulted in slightly higher current draw during sleep on ORB-C1 HW Rev 2.

SCRIPTING: increase number of persistent (NVS) variables to 50.

SCRIPTING: changes to how serial data is buffered and read. SERIAL.read() can be called anywhere in a script. SERIAL.set_handler() is optional.

SFW002-0.11.0

Release Date: 2023/03/23

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

CAN: updates to improve reliability of CAN module subsystem.

POWER: change System Shutdown threshold to Vsys < 3.5 Volts

SFW002-0.10.0

Release Date: 2023/01/24

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

SCRIPT: add new functions SQ.to_fixed(), SQ.copy(), GPS.get_data()

SFW002-0.9.0

Release Date: 2022/12/16

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

SCRIPT: added a BLE device name filter to BLE scan results to reduce memory usage.

SFW002-0.8.0

Release Date: 2022/12/13

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

SCRIPT: allow MQTT subscriptions and LWT messages to private endpoints. See scripting guide for more information.

SFW002-0.7.4

Release Date: 2022/12/07

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

SCRIPT: fix BLE advertising issue where starting advertising from script would not work.

SFW002-0.7.2

Release Date: 2022/11/22

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Changes:

SCRIPT: add SQ.lte_last_rssi() function

SCRIPT: fix critical bug in MQTT.pub() command which could cause device to crash

SFW002-0.6.0

Release Date: 2022/10/10

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Updates:

SCRIPTING: increase the max script size to 20000 bytes.

SCRIPTING: increase number of persistent (NVS) variables to 40.

SCRIPTING: add Timer.parse() function to convert a date string to a UNIX timestamp

SCRIPTING: add Timer.tzo() function to get the time zone offset (LTE connection required).

MODBUS: combine all modbus read errors into a single alert to save data.

SFW002-0.5.4

Release Date: 2022/09/28

Supported devices: ORB-C1-G, ORB-C1-H, ORB-C1-W

Bug Fix:

AZURE: fixed issue where Azure connection string could brick device (!)

AZURE: add new root certificate

MODBUS: combine all modbus read errors into a single alert to save data.

SFW002 - Changelist (ORB Gen 2 OS)

SFW002-4.2.0 [LATEST]

SFW002-4.1.0

SFW002-4.0.0

SFW002-3.2.1

SFW002-3.2.0

SFW002-3.1.2

SFW002-3.1.1

SFW002-3.1.0

SFW002-3.0.0-beta [DEVELOPMENT]

SFW002-2.6.4

SFW002-2.6.2

SFW002-2.6.1

SFW002-2.6.0

SFW002-2.5.1

SFW002-2.5.0

SFW002-2.4.0

SFW002-2.3.0

SFW002-2.2.0

SFW002-2.1.0

SFW002-2.0.0

SFW002-1.0.0

SFW002-0.11.0

SFW002-0.10.0

SFW002-0.9.0

SFW002-0.8.0

SFW002-0.7.4

SFW002-0.7.2

SFW002-0.6.0

SFW002-0.5.4

SFW002-4.2.0 `[LATEST]`

SFW002-3.0.0-beta `[DEVELOPMENT]`