Table of contents
- Table of contents
- Device Description
- Operational Modes
- Error Codes
|Rev# 1.0: 13.11.18||as||ml|
- Node - A wireless Vicotee sensor node.
- End Point - Gateway/Server where sensor data is aggregated.
- LED - Light Emitting Diode
- Driver - A specific set of instructions used to access and read measurement data from a sensor.
Vicotee nodes contain a single bi-colored LED which is used to indicate various states and to provide user feedback. Green light is used to indicate states and/or state transitions which do not require user intervention, while Red light is used to indicate errors and/or states which may require user intervention.
Please refer to Operational Modes for more information.
Vicotee nodes are equipped with a single push-button which is used to turn a node on/off and for
entering wipe-out mode. Additionally the button can be used to trigger a message to be transmitted to the end-point when a device is in Active mode. Please note, that the functionality of the button may be overridden by application-specific driver configuration which can be uploaded to a device after production. Internally the button is designed to trigger bi-directionally (i.e. capable of detecting both activation and release).
Vicotee nodes are equipped with a magnetic reed switch which is connected in parallel with the button and thus provides exactly the same functionality as the push-button described above. The reed switch pull-in range is specified to 20..25 AT (Ampere-Turns). Please refer to Application Note for more details regarding selection of a proper magnet.
Vicotee nodes can be equipped with up to two CR123A batteries with a total capacity of 3.1Ah. Typical quiescent voltage values for lithium batteries after initial run-in is about 2.7V at 20°C and 2.4V at -30°C. Values given here assume a sample rate of 3 minutes with default sensors activated. Default sensors (drivers) consist of Temperature and Humidity driver and an internal battery status driver.
BACK TO TOC
Vicotee nodes have four states, referred to as operational modes. Boot-up, wipe-out, active, and shutdown. Devices spend the majority of their life time in active state where they sample and transmit sensor data to a specified end-point maintaining extremely low quiescent current in-between measurements allowing the device to operate for years without the need to change batteries.
Vicotee nodes enter boot-up mode once batteries are inserted and the button is pushed and held for at least a second. The device will signal that it has booted up by turning on the green LED for four seconds. Following this the LED will switch from the green to red light for ten seconds during which it is possible to manually enter wipe-out mode. If wipe-out mode is not entered the device will automatically transition to active mode. Note that the device will also enter wipe-out mode if no valid settings are found on the device or if the device receives a command to enter wipe-out mode from the end-point while being in active mode.
BACK TO TOC
As mentioned in the previous section, the node can, manually, be sent into wipe-out mode, this is achieved by pressing, the push-button immediately after the LED changes from green to red and holding it until the red LED switches from being constantly lit to blinking 3 times with 0.25 seconds interval. When in wipe-out mode, the device will attempt to re-configure itself to factory default settings, this means that all drivers will be erased and substituted with default stock drivers, furthermore, the assigned end-point will be reset to Vicotee's default end-point and dns-resolve flag will be set. Using wipe-out mode is advisable when user has uploaded and/or applied incorrect settings which resulted in incorrect operation of the node.
BACK TO TOC
Upon entry into Active mode, the device will attempt to auto-attach itself (automatic operator selection) to a network using information stored on the SIM-card. The device can spend up to 2.5 minutes while trying to attach itself to a network, during this time, the device will briefly blink the red LED twice to indicate that it's trying connect. The blinking pattern will repeat every 10-14 seconds until a connection is made, followed by blinking of green LED for 30 seconds to indicate that the device has successfully attached itself to a network. If the device fails to establish connection to network, the device will reboot, effectively re-entering the Boot-up state. There are multiple reasons for why the device is unable to attach itself such as: bad coverage, SIM related issues, inability to resolve hostname due to no server response etc. Reboot can also occur while the device is attached to a network, typically because the device either was instructed to perform a reset or a failure during transmission happened, reception and/or dns-resolve sequence has occurred. The cause of latest reset will be reported next time the device attaches itself to a network. Please consult the Error Codes section to determine the cause of reset.
When in active mode a node can be forced to transmit a message to the end-point by briefly pushing the push-button. This can be used for testing/debugging during deployment phase. Please note that the push-button functionality may be overridden by user-specific drivers and thus the actual response from the device may differ from the default one described here. The device, upon release of the push-button, will also signal the current state of its connectivity, two rapid red LED blinks indicate no connectivity, while two rapid green LED blinks means that the device is attached. A delay in the LED response due to the asynchronous nature of push-button events in relation to internal state of the node and the fact that the LED sub-system runs at the lowest priority may be experienced.
Successful attach will also force the device to identify itself to the preprogrammed end-point, this means that the device will transmit details about current firmware/configuration version and loaded drivers, such that the end-point can decide if new configuration data is needed to be uploaded. Furthermore, any internal drivers that are uploaded to the device will be activated with the sample rate specified by the driver, causing the device to transmit sensor-data at pre-defined intervals. Upon each transmission, the device will briefly enter (15 second timeout) reception mode, allowing the end-point to transmit new configuration data to the device.
While in Active mode, the device may be forced into shut-down mode if the push-button is pressed, and held, for at least 30 seconds (given that the push-button functionality is not overridden) until the red LED is turned on. Upon release of the push-button the red LED will still be lit for at least 5 seconds before turning off the device. The device is now turned off and may be re-started as described in the Boot-up section above. Device shutdown can also be performed remotely by issuing a specific command from the end-point.
Please note that once the device has been turned off via the push-button, external command, or by, simply, removing the batteries, internally, the device still has some charge accumulated and thus, to avoid turning the device back on accidentally let the device rest for a minimum of two minutes before re-starting or re-inserting batteries.
Error code is a compound error message which contains information about which module triggered an error and an error code. Lower 8 bits describe the actual error code, while the upper 8 bits define the module which triggered the error.
|0||Internal driver sub-system|
Narrowband error codes
|2||Modem hardware failure|
|4||SIM card error|
|5||Socket configuration error|
|6||Failed to attach to network|
|9||Failed to retrieve cell information|
|12..17||Dns service failure|
|18..24||Rx/Tx session failure|
Driver/Hal error codes
|5||Object not found|
|8||Device is busy|
|9||Resource is corrupted|
|10||Resource is used|
|12||Resource is read only|
|13||Error while flash erase|
|16||Resource already exists|
|17||Request is valid but not supported|
|22||Voltage too low to complete operation|