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