ATIM ACW-RPI User manual

ACW-RPI-2021-02-11
Atim Cloud Wireless
ACW-RPI
User Guide

2
EN-UG ACW –RPI | ATIM
Contents
Contents.............................................................................................................................................................2
Version History...................................................................................................................................................3
Disclaimer of liability..........................................................................................................................................4
Trademarks and copyrights ...............................................................................................................................4
Technical support...............................................................................................................................................4
Technical features..............................................................................................................................................5
Quick start « shield » .........................................................................................................................................6
Documentation of ARM module:...............................................................................................................6
Library C/C++ (ARMAPI):............................................................................................................................6
Example « Hello world » with the API ARMAPI in C ..........................................................................................7
ACW-RPI schematic............................................................................................................................................8
Annexes..............................................................................................................................................................9
UART configuration for RPI3 model..........................................................................................................9
Drive the RESET Pin of the ACW-RPI shield .............................................................................................10

3
EN-UG ACW –RPI | ATIM
Version History
Version
Date
Description
Auteur
0.1
17/05/2016
Creation
AM
1.0
03/06/2016
Review
YL
1.1
11/02/2021
Add notes for RPI3 compatibility
AC

4
EN-UG ACW –RPI | ATIM
Disclaimer of liability
The information in this document is subject to change without notice and does not
represent a commitment on the part of ATIM radiocommunications. ATIM radiocommunications provide
this document without warranty of any sort, express or implied, including, but no limited, the implied
warranties of merchantability or aptitude for a particular usage. ATIM radiocommunications can bring the
improvement and/or change in this manual or the product and/or firmware describe in this manual at all
time.
Trademarks and copyrights
ATIM radiocommunications®, ACW ATIM Cloud Wireless®, ARM Advanced Radio Modem®
are registered trademark of ATIM Sarl in France. The author marque mentioned in this document are the
property of their respective owners.
Technical support
For all information or technical problems, you can contact our technical support by e-mail
or phone:
0820 950 975
https://www.atim.com/en/technical-support/

5
EN-UG ACW –RPI | ATIM
Technical features
Dimensions
67 x 35 x 13 mm
Antenna
50Ω via SMA/UFL
Radio Regulation
EN 300 220 V2.4.1
Temperature
-30°C à +70°C
Frequency
865 –870 MHz
Output power
25 mW (14 dBm)
Data rate
Local : 1.2 à 115 Kbit/s
Sigfox : 100 bps
LoRaWan : 300 bit/s à 10 Kbit/s
Consumption (ARM)
Local :
Sigfox :
LoRa :
Mode Tx
60 mA
60 mA
50 mA
Mode sleep
7 µA
7 µA
7 µA
Mode Rx
35 mA
35 mA
18 mA
Mode SNIFF
300 µA
Shield Pinout
Pins mapping:
Pins
Description
+3.3V
Power3.3V
GND
Ground
𝑅𝐸𝑆𝐸𝑇
Reset of module by low state.
Rx
Rx UART
Tx
Tx UART

6
EN-UG ACW –RPI | ATIM
Quick start « shield »
The ACW-RPI shield is intended to be plugged on raspberry-pi board. The communication
with the shield is done by UART interface, there are both ways to do this: directly through the AT
command or by an application programming interface ARMAPI.
Notes : From Raspberry PI 3 model, a special configuration is required to access UART. Make sure to follow
the guide in annex to make the UART work properly.
The RESET pin of the shield is connected to the radio module RESET pin. By default, the pin
is LOW which force the module to reset. To enable the radio module, you must drive the GPIO4 of the RPI
to HIGH (see Annex for instructions).
Documentation of ARM module:
The ACW-RPI shield support the ARM-NANO module (ARM-Nx-xx) from ATIM. Please see
the 'RF Modules' section of 'Documentation' page from http://www.atim.com website to get the full
documentation about the module.
Library C/C++ (ARMAPI):
A C and C++ API (ARMAPI) is freely available on github
http://atim-radiocommunications.github.io/armapi/. You will find the examples and the documentation of
API. For raspberry-pi use the unix port (armport_unix.c). The hierarchy of API is show below:
Notes: Starting from Raspberry PI 3 model, the UART interface /dev/ttyAMA0 is no longer applicable.
Instead use /dev/ttyS0
User aplication
Arm (arm.h/c)
ArmPort (armport.h/armport_unix.c)
Hardware

7
EN-UG ACW –RPI | ATIM
Example « Hello world » with the API ARMAPI in C
The below example sends the message« Hello world » to a selected radio network.
1. //Include API
2. #include <arm.h>
3. //Instance of ARM class
4. Arm myArm;
5. //The message to sand
6. uint8_t msg[] = "Hello world";
7.
8. int main()
9. {
10. //Initialize of API and check the error code.
11. if (armInit(&myArm, "/dev/ttyAMA0") != ARM_ERR_NONE)
12. return 1;
13.
14. //If we want use the Sigfox network:
15. armSetMode(&myArm, ARM_MODE_SFX);
16. //If we want use the LoraWan network:
17. //armSetMode(&myArm, ARM_MODE_LORAWAN);
18. //If we want use the local mode:
19. //armSetMode(&myArm, ARM_MODE_SFK);
20.
21. //After to send the message, we need to send the configuration to the radio modem.
22. armUpdateConfig(&myArm);
23.
24. //Send of message.
25. armSend(&myArm, msg, sizeof(msg)-1);
26.
27. return 0;
28. }
For more details/information/examples please see the documentation of library
http://atim-radiocommunications.github.io/armapi/doc/html/index.html

8
EN-UG ACW –RPI | ATIM
ACW-RPI schematic

9
EN-UG ACW –RPI | ATIM
Annexes
UART configuration for RPI3 model
The first step is to disable linux console over the UART interface and enable the hardware UART interface.
-Run the raspi-config tool (from command line –with sudo –or from the application menu)
-Select option 5 –Interface Options
-Select option P6 –Serial
-At the prompt « Would you like a login shell to be accessible over serial ? » => Answer « No »
-At the prompt « Would you like the serial port hardware to be enabled ? » => Answer « Yes>
-Exit raspi-config and reboot the Pi for changes to take effect.
Once this step is completed open the file /boot/config.txt (with root access) and add at the end of the line
the following line:
dtoverlay=disable-bt

10
EN-UG ACW –RPI | ATIM
Drive the RESET Pin of the ACW-RPI shield
-Open a terminal and type the following commands (may require root access) :
#> echo 4 >/sys/class/gpio/export
#> echo out >/sys/class/gpio/gpio4/direction
#> echo 1 >/sys/class/gpio/gpio4/value
The radio module should me enabled then.