Microtronics EC-CAN-005 User manual

301424 | Rev.09
Cover
Valid from:
lFirmware version: 01v030
lServer version: 50v007
lHardware version: 1.4
User manual
EC-CAN-005

Chapter 1 Table of contents
Chapter 1 Table of contents
Cover 1
Chapter 1 Table of contents 3
Chapter 2 Declaration of conformity 11
Chapter 3 Specifications 13
Chapter 4 General specifications 15
4.1 Translation 15
4.2 Copyright 15
4.3 General descriptive names 15
4.4 Safety instructions 15
4.4.1 Use of the hazard warnings 16
4.4.2 General safety instructions 16
4.4.3 Safety and preventative measures for handling GSM/GPRS modems 16
4.4.3.1 Safety and precautionary measures for the GSM/GPRS modem installation 17
4.4.3.2 Safety measures for installing the antenna 17
4.5 Overview 18
4.5.1 Block diagram 19
4.6 Intended use 19
4.7 General product information 20
4.8 Device labelling 20
4.8.1 Type plates 21
4.8.2 Packaging lables 21
4.9 Installation of spare and wear parts 22
4.10 Storage of the product 22
4.11 Warranty 22
4.12 Disclaimer 23
4.13 Obligation of the operator 23
4.14 Personnel requirements 24
Chapter 5 Functional principle 25
5.1 Recommended procedure 27
5.1.1 Development of M2M/IoT application 27
5.2 Functionality of the internal data memory 27
Rev. 09 3

5.3 Memory organisation 29
5.4 Procedure in case of connection aborts 30
5.4.1 Connection abort in "online" mode 31
5.4.2 Connection abort during a Device Logic download 31
5.5 Timeout monitoring in online mode 31
5.6 Automatic selection of the GSM network 31
5.7 Determining the GSM/UMTS/LTE signal strength 31
5.8 Determining the GSM position data 32
5.9 Error handling 32
5.10 Registration memory blocks 33
5.10.1 REG_APP_OTP 33
5.11 File transfer 34
5.12 Meaning of the SIM state 35
Chapter 6 Storage, delivery and transport 37
6.1 Inspection of incoming deliveries 37
6.2 Scope of supply 37
6.3 Storage 37
6.4 Transport 37
6.5 Return 37
Chapter 7 Installation 39
7.1 Dimensions 39
7.2 Installing the EC-CAN-005 39
7.2.1 Top-hat rail assembly 40
7.3 Safety instructions for the cabling 41
7.3.1 Information on preventing electrostatic discharges (ESD) 41
7.4 Electrical installation 41
7.4.1 Connecting the sensors, actuators and power supply 42
7.4.2 Connecting the GSM antenna 43
7.4.3 Technical details about the CAN interface 44
7.4.4 Technical details about the USB interface 45
7.4.5 Technical details about the energy management 45
7.4.6 Technical details about the energy supply 46
7.4.7 Technical details about the system time 46
4Rev. 09

Chapter 1 Table of contents
Chapter 8 Initial Start-Up 47
8.1 User information 47
8.2 Applicable documents 47
8.3 General principles 47
8.4 Commissioning the system 47
8.5 Testing communication with the device 49
Chapter 9 User interfaces 51
9.1 User interface on the EC-CAN-005 51
9.1.1 Operating elements 51
9.1.1.1 Button 51
9.1.1.2 LED 52
9.2 User interface on the myDatanet server 52
9.2.1 Site configuration 52
9.2.1.1 Site 52
9.2.1.2 Comments 52
9.2.1.3 Control 53
9.2.1.4 Configuration 0 - Configuration 9 53
9.2.1.5 Alarm settings 53
9.2.1.6 Basic settings 54
9.2.1.7 FTP export settings 54
9.2.2 Device configuration 55
9.2.2.1 Comments 55
9.2.2.2 Measurement instrument 55
9.2.2.3 GPRS 56
Chapter 10 myDatanet server 57
10.1 Overview 57
10.1.1 Explanation of the symbols 57
10.2 "Customer" area 58
10.3 "Site" area at customer level 60
10.3.1 Reports 61
10.3.2 Map view 61
10.4 Recommended procedure 61
10.4.1 Creating the site 61
Rev. 09 5

Chapter 11 rapidM2M Studio 65
11.1 General 65
11.2 Prerequisites 66
11.3 Project dashboard 67
11.4 CODEbed 68
11.5 TESTbed 69
Chapter 12 Device Logic 71
12.1 General 71
12.1.1 Direct entry of a device logic 71
12.1.2 Uploading a binary file 71
12.1.3 Using the CODEbed of the web-based development environment rapidM2M Studio 71
12.2 rapidM2M Device API 72
12.2.1 Constants 72
12.2.2 Timer, date & time 73
12.2.2.1 Arrays with symbolic indices 73
12.2.2.2 Constants 73
12.2.2.3 Functions 73
12.2.3 Uplink 78
12.2.3.1 Arrays with symbolic indices 78
12.2.3.2 Constants 79
12.2.3.3 Callback functions 83
12.2.3.4 Functions 84
12.2.4 System 94
12.2.4.1 Arrays with symbolic indices 94
12.2.4.2 Constants 94
12.2.4.3 Functions 95
12.2.5 Encoding 96
12.2.5.1 Constants 96
12.2.5.2 Functions 97
12.2.6 GPIO, IRQ 102
12.2.6.1 Constants 102
12.2.6.2 Callback functions 102
12.2.6.3 Functions 103
6Rev. 09

Chapter 1 Table of contents
12.2.7 SPI, I2C, UART 105
12.2.7.1 Constants 105
12.2.7.2 Callback functions 106
12.2.7.3 Functions 107
12.2.8 Registry 114
12.2.8.1 Constants 114
12.2.8.2 Callback functions 115
12.2.8.3 Functions 115
12.2.9 Position 119
12.2.9.1 Arrays with symbolic indices 119
12.2.9.2 Constants 121
12.2.9.3 Functions 122
12.2.10 Math 128
12.2.11 Char & String 131
12.2.12 CRC & hash 139
12.2.12.1 Arrays with symbolic indices 139
12.2.12.2 Functions 139
12.2.13 Various 140
12.2.13.1 Arrays with symbolic indices 140
12.2.13.2 Constants 141
12.2.13.3 Functions 141
12.2.14 Console 147
12.2.15 SMS 149
12.2.15.1 Callback functions 149
12.2.15.2 Functions 149
12.2.16 File transfer 150
12.2.16.1 Arrays with symbolic indices 150
12.2.16.2 Constants 150
12.2.16.3 Callback functions 150
12.2.16.4 Functions 152
12.2.17 LED 156
12.2.17.1 Constants 156
12.2.17.2 Functions 157
Rev. 09 7

12.2.18 Brownout 160
12.2.18.1 Callback Funktionen 160
12.2.18.2 Funktionen 160
12.3 Device Logic error codes 160
12.4 Syntax 164
12.4.1 General syntax 164
12.4.1.1 Format 164
12.4.1.2 Optional semicolons 164
12.4.1.3 Comments 164
12.4.1.4 Identifier 164
12.4.1.5 Reserved keywords 164
12.4.1.6 Numerical constants 165
12.4.1.6.1 Numerical integer constants 165
12.4.1.6.2 Numerical floating-point constants 165
12.4.2 Variables 165
12.4.2.1 Declaration 165
12.4.2.2 Local declaration 165
12.4.2.3 Global declaration 165
12.4.2.4 Static local declaration 166
12.4.2.5 Static global declaration 166
12.4.2.6 Floating point values 166
12.4.3 Constant variables 166
12.4.4 Array variables 166
12.4.4.1 One-dimensional arrays 166
12.4.4.2 Initialisation 167
12.4.4.3 Progressive initialisation for arrays 167
12.4.4.4 Multi-dimensional arrays 167
12.4.4.5 Arrays and the "sizeof" operator 168
12.4.5 Operators and expressions 169
12.4.5.1 Notational conventions 169
12.4.5.2 Expressions 169
12.4.5.3 Arithmetic 169
12.4.5.4 Bit manipulation 170
8Rev. 09

Chapter 1 Table of contents
12.4.5.5 Assignment 170
12.4.5.6 Comparative operators 171
12.4.5.7 Boolean 171
12.4.5.8 Other 172
12.4.5.9 Priority of the operators 172
12.4.6 Statements 173
12.4.6.1 Statement label 173
12.4.6.2 Composite statements 174
12.4.6.3 Expression statement 174
12.4.6.4 Empty statement 174
12.4.6.5 Assert expression 174
12.4.6.6 Break 175
12.4.6.7 Continue 175
12.4.6.8 Do statement while (expression) 176
12.4.6.9 Exit expression 176
12.4.6.10 For (expression1; expression2; expression3) statement 176
12.4.6.11 Goto label 177
12.4.6.12 If (expression) statement1 else statement2 177
12.4.6.13 Return expression 177
12.4.6.14 switch (expression) {case list} 177
12.4.6.15 While (expression) statement 178
12.4.7 Functions 179
12.4.7.1 Function arguments ("call-by-value" versus "call-by-reference") 179
12.4.7.2 Named parameters versus fixed parameters 181
12.4.7.3 Standard values of function arguments 181
12.5 Differences to C 182
Chapter 13 Data Descriptor 185
13.1 Data structure 185
13.1.1 Division of a structured measurement data channel into individual data fields 186
13.1.2 Division of a configuration memory block into individual data fields 187
13.1.3 Division of the aloha data into individual data fields 188
13.1.4 Attributes of the field definition 188
13.2 Example 193
Rev. 09 9

13.3 Special values of the data types 195
Chapter 14 API 197
14.1 Backend API 197
14.2 rapidM2M Playground 197
14.2.1 Overview 198
Chapter 15 Maintenance 199
15.1 General maintenance 199
15.2 Fuse replacement 199
Chapter 16 Removal/disposal 201
Chapter 17 Troubleshooting and repair 203
17.1 General problems 203
17.2 Log entries and error codes 204
17.2.1 Modem error 209
17.3 Evaluating the device log 210
17.3.1 Evaluating the device log on the myDatanet server 210
17.3.2 Evaluating the device log using DeviceConfig 211
Chapter 18 Document history 213
Chapter 19 Glossary 223
Chapter 20 Contact information 225
10 Rev. 09

Chapter 2 Declaration of conformity
Chapter 2 Declaration of conformity
Rev. 09 11

Chapter 3 Specifications
Chapter 3 Specifications
Voltage supply 24VDC (+5/-10%)
Additional information is provided in "Technical details about the energy supply" on page
46.
Power
consumption
typ. 0,5W
max. 3,5W
Integrated
buffer accu
Li-Po rechargeable battery with 900mAh for:
lReaction by application to power supply failure
lDisconnection from mobile network in the event of a power supply failure
Additional information is provided in "Technical details about the energy management " on
page 45.
Housing Material: Aluminium
Weight: 250g
Degree of protection: IP67 (alle Anschlüsse gesteckt)
Dimensions (WHD): 85 x 99 x 48mm(without antenna)
Operating
temperature
-20...+60°C
Air humidity 15...90%rH non-condensing
storage
temperature
-20...+60°C
Charging
temperature
(buffer accu)
0...+40°C
Display freely useable LED (controlled by the device logic)
Operation freely useable Button (evaluated by the device logic)
System time Hardware real-time clock with its own buffer battery (service life >10 years) and automatic
time synchronisation with the server.
Additional information is provided in "Technical details about the system time" on page 46.
Antenna
connector
2 x FAKRA for mobile network 1)
1 x FAKRA for GNSS
Interface 1 x CAN
lmax. data transfer rate: 1Mbit/s
lpermissible continuous bus load: 40%
lsupported CAN specification: V2.0B
lno galvanic isolation
Additional information is provided in "Technical details about the CAN interface" on page
44.
Rev. 09 13

Positioning GNSS module (GPS/QZSS, GLONAS, Galileo, BeiDou)2)
Data memory 3MB internal flash memory
The size of the data records is variable (max. 1023 Byte ) and is determined by the device
logic created by the user. The system-related overhead is 11 Byte per data record.
Additional information is provided in "Functionality of the internal data memory" on page 27.
Configuration
memory
10 independent blocks each with 4000 Bytes
Registration
memory
Flash: 4 blocks each with 1kB and pre-defined purposes for storing device-specific data
RAM: 1 optional block with max. 1kB for storing application-specific data
Additional information is provided in "Registration memory blocks" on page 33.
Memory for the
PAWN binary
256kB (uncompressed size)
Additional information is provided in "Memory organisation" on page 29.
Data
transmission
EC-CAN-005 (2G/3G/4G World, u-blox LARA-R6001D):
2G GPRS 1900MHz
UMTS B1, B2, B5, B8
LTE FDD B1, B2, B3, B4, B5, B7, B8, B12, B13, B18, B19, B20, B26, B28
LTE TDD B38, B39, B40, B41
SIM The EC-CAN-005 is equipped with an integrated SIM chip.
1) MAIN and AUX as preparation for moduls of the category LTE CAT-1 and higher
2) Possible failures or influences on the position determination due to existing 2.4 GHz W-LAN or 2-meter band radio.
14 Rev. 09

Chapter 4 General specifications
Chapter 4 General specifications
The information in this manual has been compiled with great care and to the best of our knowledge. The
manufacturer, however, assumes no liability for any incorrect specifications that may be provided in this
manual. The manufacturer is not responsible for direct, indirect, accidental or consequential damages which
arise from errors or omissions in this manual even if advised of the possibility of such damages. In the interest
of continuous product development, the manufacturer reserves the right to make improvements to this
manual and the products described in it at any time and without prior notification or obligation.
Note: The specifications in this manual are valid as of the versions listed on the front page. Revised versions
of this manual, as well as software and driver updates are available in the service area of the myDatanet
server.
4.1 Translation
For deliveries to countries in the European Economic Area, the manual must be translated into the language
of the respective country. If there are any discrepancies in the translated text, the original manual (German)
must be referenced or the manufacturer contacted for clarification.
4.2 Copyright
The copying and distribution of this document as well as the utilisation and communication of its contents to
others without express authorisation is prohibited. Contraventions are liable to compensation. All rights
reserved.
4.3 General descriptive names
The use of general descriptive names, trade names, trademarks and the like in this manual does not entitle
the reader to assume they may be used freely by everyone. They are often protected registered trademarks
even if not marked as such.
4.4 Safety instructions
For the connection, commissioning and operation of the EC-CAN-005 , the following information and higher
legal regulations of the country (e.g. ÖVE), such as valid EX regulations as well as the applicable safety and
accident prevention regulations for the respective application case must be observed.
Read this manual completely before unpacking, setting up or operating this device. Observe all hazard,
danger and warning information. Non-observance can lead to serious injuries to the operator and/or damage
to the device.
Ensure that the safety equipment of this measurement instrument is not impaired. Install and use the
measurement system only in the manner and method described in this manual.
Important note: The manufacturer's products that are designed for outdoor use include extensive
protection against moisture and dust penetration. However, this only applies if all connectors that are
not used are covered with the corresponding counterparts. The operator is responsible for protecting
unused plugs against penetrating moisture and dust and for complying with local safety regulations.
Rev. 09 15

4.4.1 Use of the hazard warnings
DANGER:
Indicates a potential or threatening hazardous situation that will result in death or serious
injuries if not avoided.
WARNING:
Indicates a potential or threatening hazardous situation that can result in death or serious
injuries if not avoided.
CAUTION:
Indicates a potential hazardous situation that can result in minor or moderate injuries or
damage to this instrument.
Important note: Indicates a situation that can result in damages to this instrument if it is not avoided.
Information that must be particularly emphasised.
Note: Indicates a situation that does not result in any injury to persons.
Note: Information that supplements the specifications in the main text.
4.4.2 General safety instructions
WARNING:
Ensure that the device is fully deactivated and cannot activate automatically when
sending/returning it as air freight. Information on this is provided in chapter "Storage of
the product" on page 22. If you have any unanswered questions, contact the manufacturer
(see "Contact information" on page 225).
WARNING:
Never use this device in areas where the use of wireless equipment is prohibited. The
device must not be used in hospitals and/or in the vicinity of medical equipment, such as
heart pacemakers or hearing aids, as their functionality could be compromised by the
GSM/GPRS modem contained in the device.
WARNING:
Never use this device in potentially explosive atmospheres and in the vicinity of highly
combustible areas (storage areas for combustible material, chemical plants and
detonation sites) or in the vicinity of flammable gases, vapours or dust.
4.4.3 Safety and preventative measures for handling GSM/GPRS modems
The following safety and preventative measures must be observed during all phases of installation, operation,
maintenance or repair of a GSM/GPRS modem. The manufacturer is not liable if the customer disregards
these preventative measures.
CAUTION:
The GSM/GPRS modem connection must not be used in hazardous environments.
No guarantee of any kind, whether implicit or explicit, is given by the manufacturer and its suppliers for the use
with high risk activities.
16 Rev. 09

Chapter 4 General specifications
In addition to the following safety considerations, all directives of the country in which the device is installed
must be complied with.
Important note: No liability shall be assumed at any time and under no circumstances for
connections via a GSM/GPRS modem for which wireless signals and networks are utilized. The
GSM/GPRS modem must be switched on and operated in an area where sufficient signal strength is
present.
4.4.3.1 Safety and precautionary measures for the GSM/GPRS modem installation
lThis device must only be installed by a trained technician who applies the recognised installation
practices for a radio frequency transmitter including the correct grounding of external antennas.
lThe device must not be operated in hospitals and/or in the vicinity of medical equipment such as heart
pacemakers or hearing aids.
lThe device must not be operated in highly flammable areas such as petrol filling stations, fuel storage
sites, chemical factories and explosion sites.
lThe device must not be operated in the vicinity of flammable gases, vapours or dusts.
lThe device must not be subjected to strong vibrations or impacts.
lThe GSM/GPRS modem can cause interferences if it is located in the vicinity of television sets, radios
or computers.
lDo not open the GSM/GPRS modem. Any modification to the device is prohibited and will result in the
operating licence being revoked.
lThe use of GSM services (SMS messages/data communication/GPRS, etc.) may incur additional
costs. The user is solely responsible for any resulting damages and costs.
lDo not install the device in any other way to the one described in the operating instructions. Improper
use will invalidate the warranty.
4.4.3.2 Safety measures for installing the antenna
lOnly use antennas that are recommended or supplied by the manufacturer.
lThe antenna must be installed at a distance of at least 20 cm from individuals.
lThe antenna must not be extended outside protected buildings and must be protected against lightning
strikes.
lThe voltage supply must be switched off before replacing the antenna.
Rev. 09 17

4.5 Overview
Front of the EC-CAN-005 Rear of the EC-CAN-005
1Pressure compensation 5Connector for the supply and the CAN bus
2LED 6Connector for the primary mobile radio antenna
(MAIN)
3Button 7Connector for the secondary mobile radio
antenna (AUX)1)
4Connector for the GNSS antenna 8Assembly loop (for attachment to a top hat rail)
1) as preparation for modules of the categories LTE CAT-1 and higher
18 Rev. 09

Chapter 4 General specifications
4.5.1 Block diagram
Block diagram of the EC-CAN-005
4.6 Intended use
The compact, freely programmable device is a universal solution designed for determining, processing and
transferring machine data which is then read via the CAN interface. The device requires a permanent energy
supply. The measured and recorded data is stored on a non-volatile storage medium. This saved data can be
sent to a central server via the mobile network for further processing. The device is equipped with an
integrated SIM chip for this purpose. The maximum permissible limit values specified in chapter
"Specifications" on page 13 must be observed. The manufacturer shall not be liable for any operational cases
that deviate from these limit values and have not been approved by the manufacturer in writing.
Note: This device is exclusively intended to be used for the purposes as described before. Any other
use or use beyond what is specified or a modification of the device shall be deemed to be not for the
intended purpose and is not permitted without the express written consent of the manufacturer. The
manufacturer shall not be held liable for any damages that may result from such unauthorised use or
modification. The operator alone bears the associated risk.
Note: The manufacturer is not liable for data loss of any kind.
Note: The integrated SIM chip provides a mobile communications connection to a variety of
international service providers. In order to be able to utilise all functions of the device, you must
ensure that the device is located in the service area of one of these service providers. You can find a
list of all supported countries and associated service providers under
www.microtronics.com/footprint. A Managed Service contract with Microtronics Engineering GmbH
is required for use of the mobile data transmission (see www.microtronics.com/managedservice).
This includes the provisioning of the mobile communications connection via the network of the service
provider included in the above-mentioned list.
Rev. 09 19

4.7 General product information
The EC-CAN-005 is a compact, freely programmable device for determining, processing and transferring
machine data. To acquire the data, there is a non-galvanically isolated CAN interface. It should be noted that
the EC-CAN-005 is only suitable for systems with a continuous bus load of up to 40% . The EC-CAN-005 is
also equipped with a multi-GNSS modul for an exact determination of the position. However, an external
GNSS antenna is required to use this function. In the event of a power failure the integrated buffer battery
allows an appropriate application-specific response to be implemented or enables correct deregistration from
the mobile radio network. Thanks to the hardware real-time clock with its own buffer battery the system time
still continues to run even when the device is switched off, which means a valid time base is immediately
available following recommissioning.
The customer can create their own application via the rapidM2M Studio (see "rapidM2M Studio " on page 65).
During development the part of the application that needs to be installed on the device (i.e. the device logic) is
loaded into the EC-CAN-005 via the USB interface. For applications that are provided via the rapidM2M
Store , installation of the device logic is performed via the mobile network connection in the course of
connecting the site with the EC-CAN-005 . The device logic enables access to the CAN interface thus
providing the customer with the option to connect to almost all of the devices that are compatible with this
interfaces and to implement the corresponding communication protocols.
Important note: The USB interface is intended as a mainenance interface that is only accessible
once the housing has been opened. The manufacturer is not liable for damage to the device, e.g. due
to the ingress of moisture, which can be attributed to opening the housing.
The EC-CAN-005 provides the customer with a memory area for their data (3MB ) as well as 10 independent
memory blocks each with 4000 Bytes for the configuration data. In addition to the EC-CAN-005 registration
memory blocks each with 1kB , that are saved in the flash, the EC-CAN-005 has another one that can
optionally be initialised via the "rM2M_RegInit()" function and that is saved in the RAM. Its size can be
specified during initialisation, although it is limited to a maximum of 1kB . The registration memory blocks are
assigned to predefined purposes and are designed for storing device-specific data (see "Registration
memory blocks" on page 33). The customer is responsible for initialising the connection to the central
myDatanet server via the mobile network connection (see "rM2M_TxStart()"). However, the system
automatically synchronises the configuration, registration and measurement data with the server. The EC-
CAN-005 is equipped with an integrated SIM chip for this purpose.
4.8 Device labelling
The specifications in this user manual apply exclusively to the EC-CAN-005 device type.
Note: These operating instructions are part of the device and must be available to the user at all
times. The safety instructions contained therein must be observed.
WARNING:
It is strictly prohibited to disable the safety equipment or modify its mode of operation.
20 Rev. 09