Table of contents THIS USER GUIDE IS APPLICABLE TO THE FOLLOWING REFERENCES ....................4 VERSION HISTORY OF THIS DOCUMENT ............................. 4 DISCLAIMER ....................................5 TRADEMARKS AND COPYRIGHTS ..............................5 DECLARATION OF CONFORMITY ..............................5 ENVIRONMENTAL GUIDELINES ..............................6 ....................................6 NVIRONMENT ......................................
Page 3
Lifetime frame ..................................27 Error and general alarm frame ..............................28 ..................................30 XAMPLES OF FRAMES Measurement frame ................................30 Measurement alert frame ................................ 32 DOWNLINK ....................................33 ..........................E CHANGING PARAMETERS RREUR IGNET NON DEFINI ........................E SENDING DOWNLINK COMMAND RREUR IGNET NON DEFINI TECHNICAL SUPPORT ........................
This user guide is applicable to the following references Product Version Product reference (Visible on the product label) LoRaWAN ACW/LW8-THX Sigfox ACW/SF8-THX Version history of this document Software version Version Date Description Author concerned /Revision 17/01/2022 Creation of the document V1.0.2 / B1 ATIM_ACW-THX_UG_EN_V1.1...
ATIM Sarl in France. Other trademarks mentioned in this document are the property of their respective owners. Declaration of conformity All ACW (Atim Cloud Wireless®) products comply with the regulatory requirements of the R&TTE Directive 1999/5/EC Article 3 : 1 Safety (Article 3.1a of Directive 1999/5/EC)
Environmental recommendations a. Environment Observe the storage and operating temperature ranges of the products. Failure to do so may result in operational disruption and even damage to the equipment. This equipment is not designed for an outdoor environment ! Follow the precautions and instructions listed below to ensure your safety and that of your environment and to prevent damage to your equipment.
Technical specifications a. Product Dimensions 80 x 80 x 35 mm Antenna Integrated (¼ wave) -20°C to +55°C (operating) Temperature -40°C to +70°C (storage) Fastening Mural Home automation Power supply 1 pack of Lithium batteries 3,6V / 7,2 Ah Weight 100 g Frequency 863 –...
a. Footprint <- Holes of -> fasteners b. Fastening The ACW-THX is fixed to a wall with two screws that fit into the two fixing holes at the back of the case. The holes of the cover must be on the right, in the same direction as the picture below. c.
d. Identification The Sigfox or LoRaWAN identifier of the product is visible on the external label on the back of the product, inside on the electronic board, and in the status bar of the ACW configurator. For LoRaWAN modems, the communication keys are automatically given by the network (pairing by "Over The Air Activation", or OTAA).
Operation a. Mode of operation To find out the status of the product, you just need to pass a magnet briefly (<2 sec) against the QRCODE label, which causes the LED to light up. The color of the LED indicates the operating mode of the product as described: Storage mode : When you take the product out of its packaging, it is by default in this storage mode, which optimizes the life of the batteries by avoiding their oxidation.
b. Putting the product into service Unless otherwise requested, ACW products are delivered with batteries connected and set to "storage" mode. To place the product in its operating mode, hold a magnet against the QRCODE label for 6 seconds. During these six seconds, the product's LED should blink WHITE and then...
Special case For a Sigfox product To have the information on the quality of the Sigfox network (GREEN, YELLOW or ORANGE light signal), it is necessary to provide a Sigfox Downlink. It is this one which will allow to rule on the quality of the network. The product emits at startup a test Uplink described in the chapter Classic frame (frame type 0x02).
f. Exceeding the threshold When thresholds have been configured using the configurator and the measurement values exceed these thresholds, the product LED emits a periodic ORANGE flash to notify this. g. Substitution to the magnet It is possible to use the push button on the ACW-THX board to perform the same actions as the magnet (switch the product on or off, view the product status, send a test frame).
Page 14
NOTE The product must be in its configuration mode to be detected by the configurator. For safety reasons, configuration is only possible for 5 minutes after the product has been started. First of all, the product must be put into deep sleep mode (magnet close for 6 seconds), wait about 20 seconds for the entry into deep sleep to be effective, then wake up the product (magnet 6 seconds again).
b. Configuration of the ACW-THX Transmission period and samples in the frame The transmission period corresponds to the time interval between each transmission of a measurement frame. This period can be configured from : ⚫ 1 min to 255h for a LoRaWan product ⚫...
Page 16
It is possible to configure the number of samples in a frame . Thus, several measurements will be made before sending the frame that will contain all these measurements. For example, with a period of 60 minutes and a number of samples of 4, a measurement will be made every 15 minutes and the 4 samples will be sent in 4 frames every hour.
Period of the life frame A life frame can be issued periodically. This frame will contain the supply voltage of the product. The value of this period can be configured from 1 hour to 1 month. By default, the value is set to 1 day. Timestamp of the frame is possible to disable/enable time stamping of all radio frames.
Radio module configuration It is possible for the product to work in three different ways both in LoRaWAN and in Sigfox : For a LoRaWAN product 1. LoRAWAN Class A : The product modulation is done in LoRa and uses the LoRAWAN Class A protocol. This is the default mode of the product.
For a Sigfox type product 1. Sigfox : Modulation and Sigfox protocol used. This is the default mode of the product. This mode requires an access to the Sigfox network to work. 2. Local mode : The modulation of the frames is done in FSK. In this mode, you have to choose the radio channel on which the product will transmit.
Sensor configuration Here are the configuration parameters available for this sensor : Vibration detection The ACW-THX is equipped with a vibration sensor that allows to send a radio alarm in case of movement detection on the product. (see chapter Alert frame for all available alerts). This vibration sensor has two settings: •...
c. Factory configuration Radio frame parameters Transmission period of a radio frame : 1 hour Number of samples : 1 Depth of history : 1 General parameters Lifetime frame sending period : 1 time per day Timestamp : disabled Radio parameters : LoRaWAN Class A (for LoRAWAN product) / Sigfox (for Sigfox product) Sensor parameters Vibration sensor Status : activated...
d. Updating ACWs When connected to the product via Bluetooth Low Energy, it is possible to update the different internal software (Firmwares). To do this, go to the menu Tools->Updater (CTRL+U) ATIM_ACW-THX_UG_EN_V1.0...
UPLINK frame format a. Description Trame Uplink Byte 1 Byte 2 . . . Byte Frame header Data specific to the frame Three types of frames can be differentiated : • Classic frame ; New generation : Very close to the old frames, the difference is that you can activate the timestamp.
The different types of frames Type of frame Size of the data Description of the frame 0x00 Reserved 0x01 4 bytes Frame of life. 0x02 0 bytes Downlink request for network test. 0x03 Reserved 0x04 Reserved 0x05 1 byte Test frame with counter. 0x06 Variable (Cfg box) Response to a configuration frame.
Page 25
For each of the channels, a header is inserted afterwards and is constituted in the following way : Byte 2 Channel header Bit7 Bit6 Bit5 Bit4 Bit3 Bit2 Bit1 Bit0 Reserved = 0 Lane number Type of measurement Type of measure possible Type of Units Size of the data...
Measurement alert frame Byte 1 - Header Bit7 Bit6 Bit5 Bit4 Bit3 Bit2 Bit1 Bit0 Timestamp Measurement Reserved generation frame = 0 Alert frame (= 0x0d) (Disabled = 0, Enabled = 1) If the timestamp is enabled, 4 bytes with the timestamp value are preceded by the header (byte 1). A header is inserted for each of the channels being alerted and is made up as follows : The alert type field allows you to identify whether it is an exceedance of the high threshold, the low threshold or a return between the thresholds.
Frame of life The life frame is sent at regular intervals according to the applied configuration (by default 1 day) and contains the battery levels of the product at no load (the product is doing nothing) and at load (the product is transmitting a radio frame).
Error and general alarm frame Byte 1 - Header Bit7 Bit6 Bit5 Bit4 Bit3 Bit2 Bit1 Bit0 Timestamp Measurement Reserved generation= Error frame = 0x0e frame = 0 If the timestamp is enabled, 4 bytes with the timestamp value will be preceded by the header (byte 1). For each of the error messages, a header is inserted and is made up as follows : Byte 2 - Header Error message Bit7...
Page 29
RAM is corrupted 0x8D ERR_RAM Initialization of the radio module has failed 0x8E ERR_ARM_INIT_FAIL The module is already busy (possibly not initialized) 0x8F ERR_ARM_BUSY The module is in bridge mode, impossible to send data by 0x90 ERR_ARM_BRIDGE_ENABLE radio Radio buffer is full 0x91 ERR_RADIO_QUEUE_FULL Error during initialization of the black box...
b. Examples of frames Measurement frame With time stamp disabled, no history and a sample count of 1 (Temperature and humidity only) : Bytes 0xA0 0x08 0x09 (new generation (channel 0, measurement 0x08 0x85 (channel 0, measurement 0x17 0xDE measurement frame, no type: temperature) type: hygrometry) history, 1 sample)
Page 31
Now with a number of samples of 2 : Bytes 2 et 3 0x08 0x09 0xA1 (channel 0, (channel 0, (new generation 0x003C measurement 0x01 0x2C 0x08 0xA4 type of 0x22 0x13 0x17 0xDE measurement frame, no (issue period) type: measurement: history, 2 samples) temperature)
Measurement alert frame For a high threshold violation on channel 1 (virtual probe), the frame will be : Byte 0x58 0x8D (High threshold exceeded on channel 1, temperature 0x02 0xC9 (New generation alert frame) measurement) The sample that triggered the threshold is 0x02C9 (7.13 °C) ATIM_ACW-THX_UG_EN_V1.0...
Downlink This feature is available on ACW-THXs meeting the following conditions: Software applicatif Firmware radio Sigfox version V1.0.2 V5.9.3.1 LoRaWAN version V1.0.2 V5.1.1 Downlinks do two things for the product: • Modification of product parameters • Send commands to products Downlink operation is explained in document ATIM_ACW-DLConfig_UG_EN_v1.4, relating to version V1.2.0 of the ATIM Downlink Protocol (see this document for all parameters and commands common to all products).
Page 34
a. Parameter modification The configurator can be used to generate downlinks for remote parameterization of a product. These downlinks can then be sent via the Sigfox or LoRaWan network. To do this : • Open the product configuration page (a virtual page can be opened if the product is not physically in range) •...
Page 35
• Simply select the parameter(s) you wish to apply via downlink and build the associated downlink. Here, for example, we want to modify the radio configuration, timestamp and datalogging parameters. The downlink to be sent will then be 4400000b009400013c00 WARNING For Sigfox products, downlinks are limited to 8 bytes.
Page 36
b. Send downlink command Downlink commands are explained in document ATIM_ACW-DLConfig_UG_EN_v1.4, relating to version V1.2.0 of the ATIM Downlink Protocol. ATIM_ACW-THX_UG_EN_V1.0...
Page 37
Technical support For any information or technical question, please open a ticket on our dedicated support web page: https://www.atim.com/support-technique/ ATIM_ACW-THX_UG_EN_V1.0...
Need help?
Do you have a question about the LoRaWAN ACW/LW8-THX and is the answer not in the manual?
Questions and answers