Atim Cloud Wireless ACW/SF8-LVL User manual
ATIM Radiocommunications
Chemin des Guillets
38250 Villard de Lans
France
ATIM Cloud Wireless
Ultrasonic distance measurement
LVL
User Guide
Concerned models:
ACW/SF8-LVL
ACW/LW8-LVL
2
ATIM_ACW-LVL_UG_EN_V1.5
Table of contents
THIS USER GUIDE IS APPLICABLE TO THE FOLLOWING REFERENCES ........................................................................................... 4
DOCUMENT VERSION HISTORY .................................................................................................................................................. 4
DISCLAIMER ............................................................................................................................................................................... 5
TRADEMARKS AND COPYRIGHT ................................................................................................................................................. 5
DECLARATION OF COMPLIANCE ................................................................................................................................................. 6
ENVIRONMENTAL RECOMMENDATIONS.................................................................................................................................... 7
A.EXPLOSIVE ATMOSPHERE .............................................................................................................................................................. 7
B.ENVIRONMENT........................................................................................................................................................................... 7
C.RADIO ...................................................................................................................................................................................... 7
TECHNICAL SPECIFICATIONS ....................................................................................................................................................... 8
PRODUCT .................................................................................................................................................................................. 8
SENSOR’S SPECIFICATIONS ..................................................................................................................................................................... 8
CASING....................................................................................................................................................................................... 9
FOOTPRINT................................................................................................................................................................................ 9
PRODUCT IDENTIFICATION .......................................................................................................................................................... 10
INSTALLATION AND DISMANTLING ................................................................................................................................................ 11
INSTALLATION .......................................................................................................................................................................... 11
MAGNET POSITION.................................................................................................................................................................... 13
OPERATING .............................................................................................................................................................................. 14
OPERATING MODES................................................................................................................................................................... 14
PRODUCT START-UP ........................................................................................................................................................................... 15
TEST FRAME EMISSION........................................................................................................................................................................ 16
DEEP SLEEP SETUP ............................................................................................................................................................................. 16
RADIO MODULE ACTIVITY .................................................................................................................................................................... 16
BATTERY PASSIVATION........................................................................................................................................................................ 16
ACW CONFIGURATOR............................................................................................................................................................... 17
COMPATIBLE CONFIGURATOR VERSION.......................................................................................................................................... 17
ACW-LVL SETUP ..................................................................................................................................................................... 18
Emission period and samples in the frame ............................................................................................................................. 18
Keep alive frame period .......................................................................................................................................................... 18
Frame timestamp .................................................................................................................................................................... 19
Configuration of the Radio module......................................................................................................................................... 19
Product versions ...................................................................................................................................................................... 20
Sensor’s configuration ............................................................................................................................................................. 20
Setup validation....................................................................................................................................................................... 21
FACTORY SETTINGS.................................................................................................................................................................... 22
UPDATES OF ACW.................................................................................................................................................................... 23
FRAMES FORMAT ..................................................................................................................................................................... 24
SIGFOX AND LORAWAN............................................................................................................................................................ 24
Classic frame............................................................................................................................................................................ 24
Measurement frame................................................................................................................................................................ 25
Alert frame............................................................................................................................................................................... 26
Keep-alive frame...................................................................................................................................................................... 27
Error frame............................................................................................................................................................................... 28
EXAMPLES OF FRAMES ........................................................................................................................................................................ 30
Measurement frame................................................................................................................................................................ 30
3
ATIM_ACW-LVL_UG_EN_V1.5
Alert frame............................................................................................................................................................................... 30
DOWNLINK............................................................................................................................................................................... 31
A.CONFIGURATION OF THE FRAME PARAMETERS (SENDING PERIOD,NUMBER OF SAMPLES,ETC.)................................................................. 31
B.CONFIGURATION OF THE DISTANCE OFFSET PARAMETER.................................................................................................................... 31
C.THRESHOLD SETUP .................................................................................................................................................................... 32
D.CONFIGURING SENSOR DETECTION THRESHOLDS.............................................................................................................................. 32
TECHNICAL SUPPORT................................................................................................................................................................ 33
4
ATIM_ACW-LVL_UG_FR_V1.5
This user guide is applicable to the following references
Document version history
Version
Date
Description
Author
Software
version
0.1
06/03/2020
Document creation
AC
V0.0.1
0.2
25/03/2020
Correction
AC
V0.0.1
0.3
10/12/2020
Correction of the description of the frame of
downlink datalogging
AC
V0.0.2
0.4
03/02/2021
Addition of suggestions for mounting the case
/ updated description of the configuration
page
AC
V0.0.3
1.0
03/02/2021
Correct downlink frame / change Error code /
add mounting solutions
AC
V0.0.3
1.1
22/06/2021
Compatibility mode regarding repeaters
LoRa/LoRaWAN and FSK/Sigfox description
Modification of the operation mode
description: LED behaviour when searching for
a network.
Add guidance notes for samples sorting in
periodic frame.
Add more details for sensors technical
specifications
AC
V0.0.4
1.2
02/12/2021
New product image, add sensors detection
thresholds to downlink chapter
AC
V0.0.5
1.3
26/07/2022
Updating documentation to match the new
design of the sensor
AJ
V1.0.3
1.4
05/09/2022
Change distance format form centimetre to
millimetre
YLB
Rev B4 /
v1.0.6
1.5
06/10/2022
Addition of schemes, updates of visuals with
rubber system
AJ
Rev B4 /
v1.0.6
Product references
Product version
(Visible on the label of the
product)
LoRaWAN
ACW/LW8-LVL
B.4
Sigfox
ACW/SF8-LVL
B.4
5
ATIM_ACW-LVL_UG_FR_V1.5
Disclaimer
The information contained in this document is subject to change without warning and does not represent a
commitment on the part of ATIM radiocommunications. ATIM radiocommunications provides this document ‘as-is’
with no warranty of any kind, express or implied, including but not limited to implied warranties of merchantability or
fitness for a particular purpose. ATIM radiocommunications may make changes and/or improvements to this manual
or to the product(s) or program(s) described in this manual, at any time.
Trademarks and copyright
ATIM radiocommunications®, ACW ATIM Cloud Wireless® and ARM Advanced Radio Modem® are registered
trademarks of ATIM SARL in France. The other trademarks mentioned in this document are the property of their
respective owners.
6
ATIM_ACW-LVL_UG_FR_V1.5
Declaration of compliance
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 the 1999/5/EC Directive)
NF EN60950-1 Ed. 2006/A1:2010/A11:2009/A12:2011 (health)
EN62479: 2010 (power <20mW) or EN62311:2008 (power > 20mW)
2 Electromagnetic compatibility (Article 3.1b of the 1999/5/EC Directive)
EN 301489-3 v1.4.1, EN 301489-1 V1.9.2
3 Efficient use of the radio frequency spectrum (Art.3.2 of the 1999/5/EC Directive)
ETSI EN300 220-2 v2.4.1 and EN300 220-1 v2.4.1
7
ATIM_ACW-LVL_UG_FR_V1.5
Environmental recommendations
a. Explosive atmosphere
Except for the ACW-ATEX line specifically intended for this purpose, do not use ACW radio modems in the presence
of flammable gases or fumes. Using the equipment in such an environment constitutes a safety hazard.
b. Environment
Respect the temperature ranges for storage and operation of all products. Failing to respect these guidelines could
disrupt device operation or damage the equipment. ACW products in IP65 water- and dust-resistant housings may be
placed outdoors, but must not, under any circumstances, be submerged.
Follow the instructions and warnings provided below to ensure your own safety and that of the environment and to
protect your device from any potential damage.
Waste disposal by users in private households within the European Union. This symbol appears on a product or
its packaging to indicate that the product may not be discarded with other household waste. Rather, it is your
responsibility to dispose of this product by bringing it to a designated collection point for the recycling of
electrical and electronic devices. Collection and recycling waste separately at the time you dispose of it helps to
conserve natural resources and ensure a recycling process that respects human health and the environment.
For more information on the recycling center closest to your home, contact your closest local government office,
your local waste management service or the business from which you purchased the product.
c. Radio
Modems in the ACW line are radio-communication modems that use the ISM (industrial, scientific and medical) bands,
which may be used freely (at no cost and with no authorisation required) for industrial, scientific and medical
applications.
General hazard –Failure to follow the instructions presents a risk of equipment damage.
Electrical hazard –Failure to follow the instructions presents a risk of electrocution and physical injury.
WARNING: do not install this equipment near any source of heat or any source of humidity.
WARNING: for your safety, it is essential that this equipment be switched off and disconnected from mains
power before carrying out any technical operation on it.
WARNING: the safe operation of this product is ensured only when it is operated in accordance with its intended
use. Maintenance may only be performed by qualified personnel.
8
ATIM_ACW-LVL_UG_FR_V1.5
Technical specifications
Product
Sensor’s specifications
Ultrasonic Sensor
Range
20 cm to 5 m
Resolution
1 mm
The sensor works on the principle of Time-Of-Flight: it sends ultrasonic pulses, measures the round-trip time &
deduces the distance:
Dimensions
100 x 100 x 40 mm
Antenna
Internal
Temperature
-25°C to +70°C (Operating mode)
-40°C to +70°C (Storage mode)
Casing
IP 54
Battery
1x packs Lithium batteries
Weight
300 g
Frequency
865 –870 MHz
Power
25 mW (14 dBm)
Rate
Sigfox: 100 bits/s
LoRaWAN: 300 bits/s to 10 Kbits/s
Consumption
Sigfox
LoRaWAN
Tx Mode
60 mA
55 mA
Sleep mode
30 µA
30 µA
Rx Mode
50 mA
25 mA
Sensor
Wall
Ultrasound path
Ultrasonic sensor output
9
ATIM_ACW-LVL_UG_FR_V1.5
Casing
Footprint
Dimensions are given in millimeters.
The sensor is supplied with a mounting gasket, which must be used under certain mounting conditions.
Mounting
Holes
10
ATIM_ACW-LVL_UG_FR_V1.5
Product Identification
The Sigfox or LoRaWAN IDs of the product are visible on the outside label on the side of the product, inside on the
electronic card, and in the status section of the ACW configurator.
For LoRaWAN modems, the communication keys are automatically given by the network (pairing by "Over The Air
Activation", or OTAA).
Reading this QR Code gives the following information
ATIM|ACW/LW8-LVL|C.0|190114|1|3.0|5.11|70B3D59BA0008C0A
Meaning
ATIM
ACW/LW8-LVL
C.0
190114
1
3.0
5.11
70B3D59BA0008C0A
Manufacturer
name
Product name
Revision
version
Assembly date
Assembly site
Hardware
version
Firmware
version
Sigfox ID
or
LoRaWAN DevEUI
LVL
Serial product
number
Product ID
Revision number of the product
(Hardware version, Application
software/radio firmware)
Product reference: Sigfox
or LoRaWAN version
Sigfox ID or
DevEUI LoRaWAN
Datamatrix
Left side
11
ATIM_ACW-LVL_UG_FR_V1.5
Installation and dismantling
It is necessary to open the box to the micro-USB port allowing the
configuration of the module.
To do this, you must unscrew the four screws which hold the top
and bottom of the enclosure together.
Installation
The enclosure has 2 slots to screw the sensors. Those can be used to set it up using flat angle bracket, or on the top of
a tank which has a hole on the top.
WARNING
Fixing brackets not included
The use of the gasket supplied with the product is mandatory in the case of a tank mounting to ensure the tightness
of the product.
Screws to dismount
the enclosure.
12
ATIM_ACW-LVL_UG_FR_V1.5
IMPORTANT NOTE
Avoid all kind of obstruction around the output of the sensor, especially in closed environments like a tank. A drilling of 60mm
diameter is recommended.
WARNING
Take care about the size of the walls, the longer they are, the more interferences can happen. This can lead to false
measurements or even prevent the sensors to work.
13
ATIM_ACW-LVL_UG_EN_V1.4
Be careful with the dimensions of the tank drilling:
There is a constraint in the depth of drilling of the tank, if it is not respected, there is a risk of rebounds of the signal
what can entrain errors of measurement.
Z is the depth of the wall in mm & D, the drilling diameter, hence:
𝑍 ≤ (𝐷 − 9) × 2.14
2 − 10
With an advised diameter of 60mm, we have therefore a maximum depth of 44mm.
Magnet position
The magnet should be positioned on the left of the QR code of the left face, as shown in the following pictures:
When the magnet will be mentioned in the following chapters, please refer to the image above to place the magnet
correctly.
Z
D
Z
D
14
ATIM_ACW-LVL_UG_EN_V1.4
Operating
Operating modes
The operating of the ACW-LVL is divided between different modes:
-Operation mode: this is the default mode when starting the product. In this mode, the module periodically
sends measurements according to the configuration applied (if the product has never been configured, the
factory configuration applies, see Factory settings).
-Deep sleeping mode: this standby mode mainly allows you to put the product to sleep from the time it is put
into service until it is installed on site. In this mode no measurement or radio communication functions are
possible.
-Configuration mode: this mode is active FIVE minutes after exiting deep sleep mode and allows
configuration of the product in Bluetooth using the PC configurator. In addition, radio frames are sent every
minute (therefore five frames) to ensure that the product is properly commissioned. After these five
minutes, the product returns to operating mode and Bluetooth is deactivated (possibility of reactivating it
via Downlink).
-Fault mode: This mode allows the normal operation of the module to be interrupted when a critical event
occurs. The nature of the event can be multiple:
• Empty battery (battery voltage below 2.2V)
• Error on the radio module
• Error when automated tests
• Error in the application
Entering Fault mode is indicated by a flashing RED LED of the product.
If the error does not come from the radio module, the product will send 3 radio frames every 24 hours containing the
error code (s) (see Frames format for error codes). In addition, the product will emit a luminous warning depending
on the nature of the event.
Once in this mode, the module must be restarted (by disconnecting and reconnecting the battery, by a Downlink
command or with the magnet) to return to its normal operation.
At any time, it is possible to identify which mode the product is in by bringing a magnet at least for 2 seconds to the
side of the case. The product led will light up in one of these colours depending on the mode:
for operating mode
for configuration mode
for deep sleep mode
for fault mode
for the pairing mode
15
ATIM_ACW-LVL_UG_EN_V1.4
Product start-up
In most cases, the ACW-LVL is started up before delivery (battery packs already connected) and then placed in deep
standby to limit consumption.
To place the product in its operating mode, bring a magnet close to the side of the case for 6 seconds. During these 6
seconds, the product LED should flash WHITE and then GREEN after six seconds to indicate that the product has started
up.
The ACW then enters the network pairing phase. During this phase, a FUSCHIA light signal with a fading effect indicates
that the search phase is in progress.
If the connection is successful, the product will emit a light signal depending on the quality of the network:
•GREEN light signal: good quality of network
•YELLOW light signal: low quality of network
•ORANGE light signal: bad quality of network
•WHITE light signal: no information on the quality of the network
The module will then enter its operating mode and start to send information to the network depending on the
configuration.
Particular cases
•For a Sigfox device
oTo retrieve network quality for Sigfox devices, it is necessary to provision a Downlink. It is this one which
will make it possible to determine the quality of the network. The product emits at startup, a test Uplink
described in the chapter Classic frame (frame type 0x02). If a Downlink is provisioned, the information on
network quality will then be relayed by the ACW (light signal). If no Downlink is provisioned, the ACW will
always display a WHITE light signal.
oIf a WHITE light signal at the end of 5 minutes of the pairing phase is emitted by the product AND a
Downlink has been provisioned, this therefore means that the Network is not accessible.
oIf a WHITE light signal at the end of the 5min pairing phase is emitted by the product WITHOUT a Downlink
having been provisioned, this has no meaning for the quality of the network. The quality of the network
can be good as well as bad (or non-existent).
•For a LoRaWAN device
oIn the default LoRaWAN Class A operating mode, (see chapter Radio Parameters), if at the end of the 5
minutes of the pairing phase, no network has been reached, then the product goes into standby and will
restart a pairing phase of 5 minutes 24 hours later. So, if the product is placed in an area not yet covered
by a network, the product will join it when connectivity is possible.
oIn the LoRa / LoRaWAN Repeater Compatibility operating mode, (see chapter Radio Parameters), if at the
end of the 5 minutes of the pairing phase, no network has been reached, then the product emits a WHITE
light signal and enters its nominal operating mode. Even if no network has been reached, it is assumed
with this mode that an ATIM LoRa / LoRaWAN repeater located nearby will be able to repeat the Local
frames sent by the product in LoRaWAN frame on the network that the repeater will have joined.
16
ATIM_ACW-LVL_UG_EN_V1.4
Test frame emission
When the product is in its operating mode (and only in this mode), it is possible to send a test frame (which avoids
waiting for the next measurement frame) including a measurement sample.
To do this, simply bring the magnet closer until the GREEN light signal goes out. The successful sending of the test
frame will be indicated by a CYAN light signal.
Deep sleep setup
While transporting or storing the ACW-LVL, it is best to place it in its deep sleep mode to limit unnecessary energy
consumption.
From any operating mode (except fault mode), bring a magnet near the diamond marking on the box for 6 seconds.
During these six seconds, the LED of the product will flash in the colour corresponding to the operating mode then the
end of the sequence will be indicated by a WHITE fade acknowledging that the product has been put on standby. The
magnet can therefore be removed.
Radio module activity
Any sending of a radio frame is indicated by three brief GREEN flashes of the LED.
Battery passivation
The ACW-TMXP incorporates a battery depassivation feature, to limit the phenomenon of battery passivation during
prolonged phases of deep standby. This feature is automatically activated as soon as the product goes into its deep
sleep mode. The product will then wake up once a day to start the battery depassivation sequence, then the product
will automatically return to deep standby.
17
ATIM_ACW-LVL_UG_EN_V1.4
ACW configurator
Compatible configurator version
For an LVL with the following application software version:
Use the version of ACW Configurator:
Sigfox: V1.0.6
LoRaWAN: V1.0.6
V5.3.1or later
Download and install the configuration software setup ’setupACW.exe‘ at:
https://www.atim.com/en/products-configurator/
NOTE
The ACW-LVL can be configured only from its configuration mode (otherwise the ACW configurator cannot detect it). To
enter configuration mode, the device must enter its deep sleep mode first (magnet for 6 seconds), wait approximately 20
seconds for the entry to be effective and then wake up the device (magnet for 6 seconds again).
Pairing the ACW-LVL with the configurator can be done in two ways:
⚫By USB: open the case of the ACW-LVL and connect it to a computer with a micro-USB cable.
⚫By Bluetooth: make sure that Bluetooth is activated.
WARNING
Do not leave the product connected to the configurator (via USB or Bluetooth) unnecessarily, otherwise the autonomy of the
product will be seriously degraded.
18
ATIM_ACW-LVL_UG_EN_V1.5
ACW-LVL setup
Emission period and samples in the frame
The transmission period corresponds to the time interval between each sending of a measurement frame. This
period can be configured from 10 min to 255 h and its default value is 1 hour.
In addition, it is possible to configure the number of samples in a frame . Thus, several measurements will be
carried out before the sending of the frame which will contain all these measurements.
For example, with a period of 12 minutes and several samples of 4, a measurement will be made every 3 minutes and
the 4 samples will be sent in a single frame every 12 minutes.
Finally, it is possible to apply a redundancy of the data , which means that samples having been sent in the frame
n-1, n-2 or n-3 could be sent again in the frame n to the continuation of the new measurement samples (the most
recent sample first in the frame and the least recent last).
For example, for a history depth of 3, the data of the last 2 frames will be sent, in addition to the new data, in the next
frame.
Keep alive frame period
A life frame can be sent periodically . This frame will raise 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 4 days.
1
2
3
6
3
6
7
4
5
1
2
3
4
5
6
7
8
9
10
11
19
ATIM_ACW-LVL_UG_EN_V1.5
Frame timestamp
It is possible to deactivate / activate the time stamping of all radio frames .
WARNING
This option when activated monopolizes 4 bytes in the frame which cannot be used for useful data.
Configuration of the Radio module
The device can work in 3 different operating modes :
•For a LoRaWAN device:
oLoRAWAN Class A (default): The product is modulated in LoRa and uses the LoRAWAN Class A
protocol. This is the product's default mode. This mode requires a private LoRAWAN network (private
gateway), or an operated network to view the data sent by the product.
oLocal mode : Product modulation remains LoRa modulation. However, there is no LoRAWAN overlay.
In this mode, you must choose the radio channel on which the product will transmit. To be able to
receive the product frames, a radio modem with the same parameters is then required. This mode
has no real concrete use case for the moment, but future developments of this mode will provide
interesting point-to-point features.
oCompatibility mode with the ATIM LoRa / LoRAWAN Repeater: This mode should be selected when
you want to operate in classic LoRAWAN, but no network (private or operated) is accessible. This
mode, associated with the ATIM LoRa / LoRAWAN Repeater, then makes it possible to join the
LoRAWAN network through this repeater. In this mode, if the network is not joined (no JOIN_ACCEPT),
then the product will send its frames locally. The LoRa / LoRAWAN repeater then relays these frames
on the network that it has joined (the repeater must be placed at a location with connectivity to the
desired network).
IMPORTANT NOTE
If the product has access to the LoRAWAN network, the default operating mode (LoRaWAN Class A) must be used. If this mode
is chosen, while the network is accessible, the product will still send a frame over the LoRAWAN network and this same frame
in Local mode to the Repeater, which will consume battery unnecessarily.
•For a Sigfox device:
oSigfox (default): Modulation and Sigfox Protocol used. This is the product's default mode. This mode
requires access to the Sigfox network to operate.
7
8
20
ATIM_ACW-LVL_UG_EN_V1.5
oLocal mode: The modulation of the frame’s switches to FSK. In this mode, you must choose the radio
channel on which the product will transmit. To be able to receive the product frames, a radio modem
with the same parameters is then required. This mode has no real concrete use case for the moment,
but future developments of this mode will provide interesting point-to-point features.
oCompatibility mode with the ATIM FSK / Sigfox Repeater: This mode should be selected when you
want to operate in Sigfox, but the network is not accessible. This mode, associated with the ATIM FSK
/ Sigfox Repeater, then makes it possible to join the Sigfox network through this repeater. In this mode,
the product transmits these frames both on the Sigfox network and in Local (FSK modulation). The FSK
/ Sigfox repeater then relays these frames on the Sigfox network (The repeater must be placed in a
location where the Sigfox network is accessible).
NOTE IMPORTANTE
If the product has access to the Sigfox network, the default operating mode (Sigfox) must be used. If this mode is chosen, the
product will always send a frame on the Sigfox network and this same frame in Local mode to the Repeater, which will consume
battery unnecessarily.
Product versions
When connecting to the product, the configurator retrieves all the software versions of the product (product software
and radio module software) as well as the network identifier .
Sensor’s configuration
Last Level Measured : Live measure
Level Offset : Allow the sensor to set an constant offset on all
measures
Level Threshold : Create Measure Thresholds, the sensors will
send an alarm frame if they are exceeded
Level Viewer : Emulate the filling of a tank according to specified
parameters.
Detection Threshold - Advanced configuration:
Allows to calibrate different sensitivity levels on different steps,
in order to optimize the stability of the measurement and/or to
ignore possible obstacles that are outside the measurement
range desired by the user. In each range, if the reflected signal
exceeds the amplitude threshold, then it is used for the
measurement. In case of several detection peaks,the closest one
is used.
9
10
This manual suits for next models
1
Table of contents
