SFW001 - Changelist (ORB Gen 1 OS)

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


SFW001-8.2.1 [LATEST]

Release Date: 2023/12/12

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

Changes:

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


SFW001-8.2.0

Release Date: 2023/07/20

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

Changes:

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


SFW001-8.1.0

Release Date: 2023/06/30

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

Changes:

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


SFW001-8.0.0

Release Date: 2023/04/27

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

Minor Updates:

  • AA Battery: 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: changes to how serial data is buffered and read. SERIAL.read() can be called anywhere in a script. SERIAL.set_handler() is optional.


SFW001-7.1.0

Release Date: 2023/03/21

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

Minor Updates:

  • SYSTEM: update CAN module subsystem to improve recovery from ‘CAN Module Error’.

  • POWER: change System Shutdown threshold to Vsys < 3.5 Volts


SFW001-7.0.0

Release Date: 2022/12/16

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

Warning

On the first update to 7.x.x or above, all hourmeter, NVS and state records on the device will be reset to zero. (eg: state hours, ignition hours, movement hours, etc)

Major Updates:

  • SCRIPTING: increase the max script size to 20000 bytes.

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

  • 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.


SFW001-6.1.2

Release Date: 2022/09/08

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

Bug Fix:

  • SCRIPTING: fixed an issue with SERIAL.set_handler() function not triggering when serial data arrives.


SFW001-6.1.1

Release Date: 2022/09/01

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

Bug Fix:

  • SCRIPTING: fixed a bug where persistent variables could sometimes lose recent updates when a setting was changed.


SFW001-6.1.0

Release Date: 2022/08/03

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

Bug Fix:

  • SLEEP: fixed a bug causing a reset when device goes to sleep. Bug affected ORB-C1 Rev 2 hardware only.


SFW001-6.0.4

Release Date: 2022/07/15

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

Bug Fix:

  • AUTO APN: fixed a minor bug causing longer search time for the correct APN


SFW001-6.0.0

Release Date: 2022/07/12

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

Warning

On the first update to 6.x.x or above, all hourmeter & state records on the device will be reset to zero. (eg: state hours, ignition hours, movement hours, etc)

Major Updates:

  • SCRIPTING: Persistent variables can now be loaded/saved from the script, allowing values to be stored during sleep. See SQ.nvs_save function in the scripting guide for more information.

  • HARDWARE: Hardware support for Rev 2 ORB-C1 and improved sleep current.

Bug Fixes:

  • APN: fixed an issue where the Auto APN function could corrupt the APN settings under certain conditions.


SFW001-5.3.1

Release Date: 2022/07/04

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

Minor Updates & Bug Fixes:

  • LTE: Device will automatically fetch Auto-APN database if it does not exist.

  • FILE: Fixed bug when deleting a file from main filesystem.

  • NETWORK: Fix for rare connection issue when switching from WiFi to LTE network.


SFW001-5.2.0

Release Date: 2022/06/10

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

Minor Updates:

  • LTE: new Auto-APN feature added to automatically select and try suitable APN/user/pass combinations based on the inserted SIM card. This feature is enabled by default. Existing APN settings will be preserved after updating.


SFW001-5.1.1

Release Date: 2022/04/22

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

Bug Fixes:

  • SCRIPTING: fix SERIAL.set_handler() issue interfering with LTE connection on -G devices


SFW001-5.1.0

Release Date: 2022/04/14

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

Minor Update:

  • SCRIPTING: add an MQTT.queued(id) function, which allows checking if MQTT messages remain on the internal queue or have been sent


SFW001-5.0.0

Release Date: 2022/03/31

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

Warning

On the first update to 5.x.x or above, all hourmeter records on the device will be reset to zero. (eg: ignition hours, movement hours, etc)

Major Updates:

  • STATES: Add the concept of machine ‘states’ such as work, idle, offline etc. The current ‘state’ can be set from the script. The device automatically records the number of hours spent in each state. Utilisation information can then be shown on the Senquip Portal.

  • FILES: Reading/writing files on the device is now possible using the device script. Refer to scripting guide for more info.

  • WEB: the device’s local webserver allows viewing and downloading of files created by the script.

  • SCRIPTING: one device can now request data from another Senquip device (using Senquip Portal) for local processing and advanced edge decision making.

Minor Updates:

  • TIME: if a NTP server is not available, the device will get time from GPS data or from LTE network information.

  • RESET: the factory reset process will now also delete the user script.

  • SCRIPTING: added optional length parameter to MQTT.pub() which allows publishing binary data.


SFW001-4.2.0

Release Date: 2022/02/09

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

Minor Updates:

  • ENDPOINT: add support for connecting to Azure IotHub using SAS tokens.


SFW001-4.1.2

Release Date: 2022/01/25

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

Bug Fixes:

  • CAN: fix bug where a transmitted message could not have ID = 0


SFW001-4.1.0

Release Date: 2021/10/22

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

Minor Updates:

  • CAN: add support for continuous CAN capture.

  • SCRIPTING: add Math.acos() and Math.asin() functions.


SFW001-4.0.0

Release Date: 2021/09/20

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

Major Updates:

  • BLUETOOTH: add bluetooth advertising and scanning functions. All devices can now capture and report nearby BLE advertising data or deliver data to a script for processing. Each device can also advertise custom data itself from a script.

  • CAN: add ability to transmit CAN messages from a script.

  • CAN: add ability to capture both Standard and Extended CAN frames.

  • SCRIPTING: add custom settings that can be used from within the script. See scripting guide for more information.

  • SCRIPTING: feedback from the device about scripting errors. When enabled, script errors will generate warnings in the device’s data message.

  • SLEEP: greatly reduced sleep current for ORB-C1.

Minor Updates:

  • SCRIPTING: add SQ.distance function to calculate meters between the device and another GPS position.

  • SCRIPTING: add SQ.set_current function to control the current source terminals from a script.

  • SCRIPTING: add SQ.encode function to convert numbers into raw byte format (signed/unsigned 8/16/32 bits).

  • CAN: added ‘Send Raw Data’ setting. When enabled, CAN data is sent in the data message as normal. When disabled, CAN data is only delivered to the script for local processing reducing data message size.

  • HIBERNATE: Hibernate on Power Loss setting is now enabled by default.

Bug Fixes:

  • FREQUENCY INPUT: fixed a bug when capturing a frequency/duty signal AND base interval is 5 seconds.


SFW001-3.4.0

Release Date: 2021/07/22

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

Minor Updates:

  • SCRIPTING: add ‘SQ.clear_pulse_count’ function.

  • SCRIPTING: add ‘SQ.hourmeter_set’ function.

  • LTE/GSM: ability to unlock frequency bands for worldwide use. Contact Senquip for further information.


SFW001-3.3.0

Release Date: 2021/07/15

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

Warning

Minor Breaking Scripting Change: The SQ.serial_write() function has been moved to SERIAL.write()

Minor Updates:

  • MQTT: add ‘server name’ setting for MQTTS endpoints.

  • SCRIPTING: add new ‘SERIAL’ library to read and write data over RS232/RS485 terminals allowing completely customised serial logic. Refer to scripting guide for more info.

  • SERIAL: add a ‘scripted’ mode to the Serial 1 settings.

Bug Fixes:

  • CAN: automatic recovery of rare “CAN Module Error” issue.


SFW001-3.2.0

Release Date: 2021/06/11

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

Minor Updates:

  • MODBUS: add additional channels 11 - 20.

  • SCRIPTING: add new function SQ.crc to calculate Modbus CRC.

  • SCRIPTING: add HTTP.post and UDP.send functions for publishing custom messages.

  • SCRIPTING: make GSM info available from script (ICCID, IMEI, Carrier).

Bug Fixes:

  • HTTP POST: fix automatic retry of HTTP Post endpoints if connect fails.


SFW001-3.1.0

Release Date: 2021/04/15

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

Minor Updates:

  • SCRIPTING: add new functions SQ.atob and SQ.split for manipulating captured serial data.

  • SCRIPTING: add a MQTT.pub function for publishing custom messages.

  • ENDPOINT: add a Use Senquip Data Format checkbox to settings.


SFW001-3.0.0

Release Date: 2021/03/26

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

Major Updates:

  • New firmware version numbering scheme.

  • Added support for ORB-C1 and CANbus capture.

  • Added scripting support.

  • Reliability & networking fixes.

  • MQTT: Add custom data topic.

  • MODBUS: Add name, units, warnings, alarms to Modbus channels 6-10


Note

An old firmware version numbering scheme is used for releases below, and supports only the ORB-X1.


orb-x1-rc2c

Release Date: 2020/10/22

New Features

  • MODBUS: Add ability to read signed and float types.

Bug Fixes

  • MODBUS: Fix an intermittent transmit issue. Fix broken warnings/alarms.


orb-x1-rc2b

Release Date: 2020/09/21

Bug Fixes

  • GSM: remove erroneous ‘No SIM card’ message.

  • INPUT: enable AA batteries briefly every cycle in order to measure their voltage.


orb-x1-rc2a

Release Date: 2020/08/11

New Features

  • TAMPER: add ‘light’ key/value to data output. Indicates the status of the onboard light sensor.

  • CURRENT: add digital4 & digital5 modes (for Rev 3 hardware only).

  • OUTPUT: add digital3 & analog3 modes.

  • INPUTS: analog/digital inputs now sampled at the end of the current source start time.

  • MQTT: support for custom broker endpoint with TLS support.

  • MODBUS: add support for 32-bit holding or input registers in little or big endian format.

  • MODBUS: add extra modbus channels 6 to 10.

  • SERIAL: major update to serial capture to support raw binary data. Start, End and Request config strings must be sent in base64 format (Automatically done by Senquip Portal).

  • GSM: add an alert if no SIM detected.

  • LOGGING: improved log support.

  • PORTAL: updated AWS certificates.

Bug Fixes

  • Fix bug when changing password on local device webserver.

  • Fix issue where device could reset if base interval was greater than 5 minutes.


orb-x1-rc1a

Release Date: 2020/02/04

New Features

  • SERIAL: option to start a capture based on an idle time