Introduction
This project contains a user guide for the Avimesa 1000. Designed to connect with industrial 4-20 mA sensors, the Avimesa 1000 is an intelligent I/O device which provides connectivity to Avimesa Messages. The system has a highly power-efficient and capable Cortex M4F processor that manages communication, measurement scheduling, sensor interface power control, and filtering of sensor data. The firmware is power-optimized, allowing for the use of battery power where needed.
Table of Contents
- 1. Overview
- 2. Quick Start
- 3. Power Supply / Sensor Power
- 4. Antenna Information
- 5. Device Modes
- 6. LED Status Codes
- 7. Sensor Connection
- 8. Device Configuration
1. Overview
In general, the Avimesa 1000 features:
- Seven (7) analog channels used to (primarily) interface with 4-20 mA sensors
- Up to nine (9) GPIO channels (0-3.3VDC), configurable as input/output/latching/etc. exposed on a 40-pin header
- Power supply / sensor power monitoring
- Avimesa Messages Synchronization capability
- Device configuration for measurement schedule and sensor options
Figure 1 calls out the main components that are used in this guide:
A. Power Switch
B. NFC Header (for future use)
C. Antenna Connector (type U.FL)
D. Programming LED
E. LEDs 1-3 (left to right)
F. Reset Button
G. Power Connector
H. Analog Channels 1-7 (left to right)
I. Avimesa 40-pin Header (GPIO channels 9-17)
J. Shield Solder Point
Figure 1
2. Quick Start
The following assumes that the Avimesa Gateway is configured and running. Please see here for help on setting up the Avimesa Gateway.
- Attach the antenna to the
Antenna Connector
(Figure 1-C) - Attach power to the
Power Connector
(Figure 1-G) - Attach a 4-20 mA sensors to
Analog Channels 1-7
(Figure 1-H) - Slide the
Power Switch
to the ‘ON’ position (Figure 1-A)
At this point, the Avimesa 1000 will proceed to take measurements and communicate with Avimesa Messages. The Avimesa Toolkit can be used to view device data and setup the Device Driver Script and device configuration.
If more details are required, please refer to the sections that follow.
3. Power Supply / Sensor Power
3.1 Rating
Table 1 lists the power supply ratings. A battery can be used or a DC power supply.
Condition | Voltage |
---|---|
Recommended | 12-24 VDC |
Maximum | 27.5 VDC |
Minimum | 10.5 VDC |
Table 1
It should be noted that the sensors are powered directly from the input voltage (minus a diode drop ~0.7 VDC).
This feature provides flexibility in 4-2 mA sensor selection.
3.2 Installation
Attach the power supply connector to the Power Connector
(Figure 1-G).
An example of the connector required and included in the kit is PN: TODO.
3.3 Sensor Power Information
The sensors, when powered programmatically, will be supplied by the same voltage as the input voltage, minus a diode drop of roughly ~0.7 VDC. The digital section of the board is supplied via a 3.3 VDC source for reference.
4. Antenna Information
4.1 Certified Antennas
The Avimesa 1000 is certified with five (5) antennas in the following regions using the Rigado BGM-301 module:
- USA (FCC certification)
- Canada (IC certification)
- Europe (CE report)
- Japan (MIC certification)
- Australia & New Zealand (RCM report)
The following antennas are all approved for use with the Avimesa 1000:
- Pulse W1030 2 dBi 1/4 Wave Dipole – Whip Length: 108.3mm
- Taoglas FXP73.07.0100A 2.5dBi 1/4 Wave Dipole – Flex 7mm x 47mm x 0.1mm
- Pulse W1027 3.2 dBi 1/4 Wave Dipole – Whip Length: 136.8mm
- Kinsun 6670113050-145 2.0 dBi 1/4 Wave Dipole – PCB 12mm x 65mm x 0.46mm
- Kinsun 6610103081 5.0 dBi 1/2 Wave Dipole – Whip Length: 196.6mm
4.1 Installation
Simply click the antenna to the Antenna Connector
(Figure 1-C)
5. Device Modes
In general, the device runs through a sequence of acquiring data from the attached 4-20 mA sensors, synchronizing with Avimesa Messages, and sleeping. This is called Run Mode
.
A Service Mode
is used for factory setup and is not typically used by end users.
A Firmware Update Mode
is used when updating the firmware.
5.1 LED Test Mode
Upon boot up or soft reset, the device will run through an LED Test Mode
. This mode is provided to ensure the LEDs are operational, and to provide the user a window of time to put the device into service mode if needed.
5.2 Run Mode
After boot up, the normal state of the device is Run Mode
. In the mode, the device will perform measurements and synchronize with Avimesa Messages based upon it’s configuration. The configuration is setup via the Avimesa Toolkit and is described here.
5.3 Service Mode
When the device isn’t configured it will boot up into Service Mode
. The device can also be manually forced into ‘service mode’ through the following sequence.
- Soft reset the device by momentarily pressing the
Reset
button (Figure 1-F) - Immediately after the device resets (before the device transitions to
Run Mode
), press theReset
button (Figure 1-F)
5.4 Firmware Update Mode
When the device is in Firmware Update Mode
, no other functionality is available. The device will reset automatically after the firmware update completes and resume normal operation.
If the firmware update is interrupted, the device will revert the currently running firmware.
6. LED Status Codes
6.1 LED Test Mode
In this mode, the device will cycle through each of the LEDs (1-3) and LED colors (red/blue).
Figure 2
6.2 Run Mode
When in this mode, in general the LEDs represent the following:
- LED1 – Gateway Connection
- LED2 – Measurement in Progress
- LED3 – Device Cloud Connection Status
- PROG LED – Program LED
When sleeping, the device’s power switch will be on, and all LEDs will be off.
These states are represented by LEDs 1-3 using the following:
Figure 3
The same information in text form:
State | LED1 Red | LED1 Blue | LED2 Red | LED2 Blue | LED3 Red | LED3 Blue | PROG LED Green |
---|---|---|---|---|---|---|---|
Sleeping | Off | Off | Off | Off | Off | Off | Off |
Disconnected | Off | Fast Blink | Off | Off | Off | Off | Off |
Connected | Off | On | Off | Off | Off | Off | Off |
Measuring | Off | Off | Off | On | Off | Off | Off |
Synchronizing | Off | Off | Off | Off | Off | On | Off |
Updating | Off | Off | Off | Off | Off | On | Possible Blinks |
Table 2
6.3 Service Mode
When in this mode, the state are represented by LEDs 1-3 using the following:
Figure 4
The same information in text form:
State | LED1 Red | LED1 Blue | LED2 Red | LED2 Blue | LED3 Red | LED3 Blue | PROG LED Green |
---|---|---|---|---|---|---|---|
Disconnected | On | Off | On | Off | On | Off | Off |
Connected | Off | On | Off | On | Off | On | Off |
Updating | Off | On | Off | On | Off | On | Possible Blinks |
Flash Error | On | On | On | On | On | On | Off |
Table 3
6.4 Firmware Update Mode
When in this mode, the state are represented by LEDs 1-3 using the following:
Figure 5
7. Sensor Connection
7.1 Pinout
Analog Channels 1-7
(Figure 1-H) have a screw terminal connection with the following pinout:
1 | 2 | 3 |
---|---|---|
Shield (optional) | Sensor Power | Signal Return |
Table 4
If looking at Analog Channels 1-7
(Figure 1-H), pin 1 is on the left side.
7.2 Shielded Cables
Although noise resistant by design, if using a shielded cable, you can solder an earth ground to the Shield Solder Point
(Figure 1-J).
8. Device Configuration
The device is configured using the functionality exposed by the Avimesa API. An example application, the Avimesa Toolkit (https://toolkit.avimesa.com), is available to be used for this and is located at https://github.com/Avimesa/toolkit-nodejs
The JSON object used for device configuration can be referenced here
8.1 Measurement Schedule / Sleep Time
8.2 Channel Settings
The Avimesa 1000 features:
- Seven (7) analog channels used (primarily) interface with 4-20 mA sensors. Each channel features sensor power, and is configurable for power savings
- Up to nine (9) GPIO channels, configurable as input/output/latching/etc.
- Power supply monitoring (enabled by default and un-configurable)
Please reference the documentation here for more details.
8.2.1 Channel Enabled
Sets whether or not a channel is enabled or not. Please reference the documentation here for more details.
8.2.2 Channel Schedule
For future use, set to 1 for now. Please reference the documentation here for more details.
8.2.3 4-20 mA Channel Settling Time
Specifies the time duration in seconds that the system should settle a 4-20 mA sensor before acquiring data. Please reference the documentation here for more details.
8.2.4 GPIO Channel Settings
Specifies the whether a GPIO channel is an input/output, whether it is latching, etc. Please reference the documentation here for more details.