Page 2
SensusRF gateway user manual SensusRF Gateway User’s Guide Revision Date Notes Responsible Revision 10 6 October 2015 Version 2 Sensus Revision 11 1 August 2019 Version 3: Features update Revision 12 19 August 2019 Version 3: REST API Revision 13 29 October 2019...
Contents ............................3 ONTENTS ..........................6 NTRODUCTION ......................7 ARDWARE ESCRIPTION ......................... 7 ACKAGING ........................8 UTSIDE THE CABINET ........................9 NSIDE THE CABINET ..............................9 ......................... 10 OWER UPPLY AC ....................10 AINS OWER UPPLY ....................10 PTIONAL POWER SUPPLY 5.2.1 ...................
Page 5
12.2 ......................53 PERATION 12.3 ........................54 12.3.1 ..................... 55 XTERNAL IRT SUPPORT 13 A ........................56 DVANCED PTIONS 13.1 .......................... 56 ETTINGS 13.1.1 ....................56 NSTALLATION 13.1.2 ..................56 ESTARTING THE ATEWAY 13.1.3 ................... 57 ESETTING THE ATEWAY 13.1.4 ....................
Page 6
17.2.13 .......... 103 EQUEST THE LATEST PACKET FOR A SPECIFIC METER 17.2.14 ........105 EQUEST THE LATEST PACKET FOR A SPECIFIC ENSUS METER 17.2.15 ..................107 ELETE ALL ENTRIES 17.2.16 ................108 ELETE ALL ENSUS ENTRIES 17.2.17 ................. 110 ELETE SPECIFIC ENTRY 17.2.18 ................
Introduction The SensusRF™ Integrated Gateway is responsible for integrating SensusRF or OMS Endpoints with an AMR (automatic meter reading) system platform via a cellular network data connection. A network of Integrated Gateways can be either managed by a centralized network management platform IRIS , or utilize the inbuilt webserver.
Connect the GPRS/GSM antenna, hand tight only. Connect SensusRF antenna, hand tight only. There are two different antennas available for the gateway (one for 433 MHz and a different one for 868 MHz). The antenna supplied with the gateway will match the...
4 Inside the cabinet Attention: Before opening the cabinet, make sure that all AC power is disconnected! The figure below illustrates the layout inside the cabinet: SIM card holder...
Power Supply Mains Power Supply AC Attention: Before opening the cabinet, make sure that all AC power is disconnected! Warning: Internally there are live parts when switched on that may cause electric shock. A trained professional must make the electrical installation. AC POWER SUPPLY AC INPUT voltage 85-264 V AC...
Model 300.128 Model 132.0028.03 DC INPUT DC INPUT DC INPUT ( Ground (-V) Ground (-V) DC INPUT ( IMPORTANT The DC input terminal connector is rotated 180 degrees between the two DC power supply versions. 5.2.1 DC power Specification Model 300.128 Model 132.0028.03...
SIM Card Connectors On the Gateway main board, there are two SIM card slots as illustrated below. Gateways with 3G modems and firmware version “CAS Gateway Firmware Release #4B 28072020160000.cas” or newer supports both slots position and the SIM card can be inserted in either position. 3G Gateways and newer versions of the firmware: Both SIM card slots are supported:...
Page 14
Previous versions of the Gateway using 2G modems or running older versions of the firmware, only support the upper slot, as illustrated below. 2G Gateways or older versions of the firmware: Only SIM card in slot 1 (upper position) is supported: SIM card in slot 2 (bottom slot - do not use):...
Page 15
NOTE The gateway modem and firmware version can be confirmed in the Gateway web interface as describer in 9.6 - Gateway Info. NOTE “CAS Gateway Firmware Release #4B 28072020160000.cas” has the following module versions: Gateway Firmware Version: Modem 01-01-016 Services 01-01-016 Sensors 01-01-008 Sirt 01-01-019-DS2 Appia 01-01-010...
Installation Wall Mounting: For wall mounting, the enclosure should be fixed to the wall, using 7mm diameter screws. The antenna should be positioned as shown below: Pole Mounting: For pole mounting, hanger straps (not supplied) must be used.
Physical & Environmental Specifications Gateway enclosure details: • Aluminum Enclosure • Length: 306 mm • Width: 242 mm • Thickness: 113 mm • Temperature stability: -20 C to +70 C • Protection: IP65...
The SIM Card is present & the GPRS modem is registered on the GSM Network. • Communication LED: Orange LED that indicates the status of the SensusRF radio Transceiver (called SiRT). o LED blinks when the SiRT (SensusRF Radio Transceiver) receives any radio package (BUP, SEMI, RAT, …).
Gateway internal webserver Local communications with the SensusRF Gateway (e.g. for initial configuration) can be performed by connecting the mini USB cable or the Ethernet cable connected to a PC or notebook with a standard web browser, such as Chrome or Firefox. The figure below illustrates the location of these connections:...
Page 20
3) On the next screen, select the option to “Browse my computer for driver software”: 4) Then, select the option “CAS Gateway” and click on “OK”.
Page 21
5) The device is updated, as shown below:...
Page 22
The same procedures must be applied for updating the Linux USB Ethernet / RNDIS. After updating, the driver will appear in “Device Manager” as below:...
Page 23
Check the extended properties of the device and enter manually the IP address of the gateway 192.168.7.1. For this, right click on icon and select the option “Properties”, then on “Advanced” tab, type the address as shown below:...
Page 24
7) If you are using an http proxy, it is necessary to set the address 192.168.7.2 in the proxy configurations in order to access the SensusRF Gateway by Firefox:...
Window 8 and 10 drivers instalation 64-bit versions of Windows 10 and 8 include a “driver signature enforcement” feature. They will only load drivers that have been signed by Microsoft. To install the drivers mentioned before, the driver signature enforcement feature needs to be disabled.
Page 26
To disable driver signature enforcement do the following: 1. Press and hold the Shift key on your keyboard and click the Restart button. 2. Choose Troubleshoot > Advanced options > Startup Settings and click the Restart button.
Page 28
3. When your computer restarts you will see a list of options. Press F7 on your keyboard to select Disable driver signature enforcement.
Page 29
Your computer will now restart and you will be able to install unsigned drivers. Bear in mind that this method only temporarily disables driver signature enforcement, so be sure to install all the unsigned drivers as soon as you can.
Configuring the Gateway The Gateway can be configured using a Chrome or Firefox web browser. Access the file storage in the gateway called “CAS Gateway” on “My computer” (Figure 9-1) and start the webserver application by double clicking on file “START.htm” (Figure 9-2). IGURE 9-1.
On the initial page of the SensusRF Gateway are displayed the login fields, as shown in figure 9-3. 9-3. G IGURE ATEWAY To log in to the Gateway, user must provide the user/password credentials. Users The Gateway has three user roles that can be used to access its web interface: Administrator role •...
Supervisor – Task that supervises the Integrated Gateway verifying everything is working correctly. Services Task – Task that manages the webserver communication Radio Task - Task that controls the SensusRF Radio Modem Task – Task that controls the GPRS communications Sensors Task –...
On the “Gateway Info” screen has information about the Gateway hardware and firmware configuration. The information refers to the GPRS Modem, Ethernet interface, level of details logged, SensusRF Radios and the Linux operational system image version as well as the firmware versions. In order to access “Gateway Info”...
Configuring GPRS & Ethernet parameters 10.1 GPRS Parameters To configure GPRS information, click the “Communication” tab then “GPRS”. This will display the “GPRS Parameters” screen. The Figure 10-1 illustrates the path to access this screen. 10-1 - GPRS P IGURE ARAMETERS In order to configure GPRS it is necessary to fill in the fields below and then click the “Save”...
10-2 - E GPRS IGURE XAMPLE OF CONFIGURATION It is also possible to set the GPRS & server configuration remotely by sending SMS messages. This feature is explained in more details in section 16 - SMS commands. 10.2 Ethernet Parameters To configure the Ethernet settings, click the tab “Communication”...
10-4 - E IGURE THERNET ARAMETERS 10.3 DNS Parameters To configure the DNS settings, click the tab “Communication” then “DNS” (as shown in Figure 10-5) which will display “DNS Parameters” screen. 10-5 - DNS P IGURE ARAMETERS By default, DNS will be configured automatically from the network where the Gateway is connected and its “Get DNS by server”...
Server Mode Configuration When the Gateway is initialized for the first time, server mode should be configured. This configuration is available on the “Advanced” tab then the “Settings” option. 11-1 - A IGURE DVANCED ETTINGS There are two server mode options: IRIS Server and Iris Light. In IRIS Server mode, all readings collected by the Gateway are processed by the central IRIS server, and collected by a Meter Data Manager (such as Hemera).
ERVER ARAMETERS 11.2 Iris Light mode – Parameters On tab “Upload” is possible to configure the parameters to allow SensusRF Gateway in its Light Mode. For this, it is necessary to fill info in following tab options: 11-5 - U...
On the Protocol configuration web page, five features can be configured: 1. Enable or disable decryption; 2. Define a custom decryption Key; 3. Configure SensusRF device filter; 4. Enabled or disable SensusRF advanced filter 5. Configure OMS devices filter. 11-7 - P IGURE...
Enabled or disable SensusRF advanced filter The SensusRF Advanced Filter is used to avoid (filter) invalid RF telegrams that can be corrupted over the air. If the SensusRF Advanced Filter is enabled, only readings from meters received more than once during the defined “Validation Range”...
11-8 - E IGURE MAIL ROFILE CONFIGURATION The following fields must be configured: SMTP Server name • • SMTP Server port • SMTP Server Login information Type of security used • • Email addresses to send the files to (separated by a comma) Click the “Save”...
11-9 - FTP IGURE PROFILE PAGE The following fields must be configured: • Server name Server port • • FTP Server Login information • FTP security protocol Destination directory • Click the “Save” button to save configuration. To validate this configuration, click on Test button. 11.2.5 HTTP Profile If the meter readings CSV file is to be sent by HTTP or HTTPS then the HTTP page must be configured (“Upload”...
The gateway supports sending readings and alarms (see section 11.2.9 - ALARM) over HTTP(s). Both deliveries require a user and password to be configures and the HTTP(s) server URL where to send the information. HTTP/HTTPS User name used to connect to the HTTP(s) Server •...
Page 45
11-11 - R IGURE EADING CONFIGURATION To configure a task, enter: • Position: the row in the gateways schedule table this command should be stored. There are 255 positions, from 1 to 255. • Next Execution: Indicates when the command should be executed by the first time (date and time). This will be updated automatically by the gateway once the schedule has executed.
Page 46
One for SensusRF meters and another for OMS meters with the last readings collected and decrypted • by the Gateway; One for SensusRF meters and another for OMS meters with the last readings that the Gateway could • not decrypt.
{csv|zip}: csv will be used for not compressed files and zip will be used for compressed files. The content of decrypted readings files requested via the web interface or delivered by email/FTP is the same. The SensusRF decrypted readings file is composed of the following fields: METER_ADDRESS •...
Page 48
11-13 - R IGURE OUTES CONFIGURATION In the Repeaters box are listed all the repeaters reached by the gateway. This is populated automatically by the Gateway. These repeaters can be used to build one or more routes to access meters. To add a new activation route, select the desired repeater and click the Add button.
In the example above, repeater 0080 should be activated by repeaters 0067 then 0061. To activate/test a route, click the button • When route is valid and was activated correctly, the Stat field show icon • • When a route is invalid or is not activated, the Stat field displays icon NOTE: 1.
Page 50
11-16 - SNMP IGURE To enable SNMP on the gateway, access the SNMP tab window and configure the following fields: • Agent Bind Interface o The agent will be listening on that interface and only answer SNMP requests on that interface.
The SNMP agent specific variables and traps available are detailed in the gateway mib file CAS-GWT-MIB.MIB detailed in the section 19 - APPENDIX C: GATEWAY MIB FILE. NOTE The SNMP Traps maps the alarm notification, with the same trigger conditions described in section 11.2.9 - ALARM.
• Compress File: Defines if the csv alarm file should be sent compressed (.zip) or uncompressed (plain text comma separated .csv) 11.3 HISTORICAL READINGS Historical Readings are readings stored in the Gateway over time. When enabled, all meter readings will be stored up to a limit and periodically delivered over the active delivery channels.
Page 53
“Configured Storage Limit”. This limit is related to the protocols supported by the gateway, both SensusRF and OMS. • If only SensusRF is enabled in the gateway, the historical readings database will support up to 310.000 registers. If OMS is enabled in the gateway, the historical readings database will support up to 155.000 •...
Radio Info 12.1 Radio Info In order to select ‘Devices Info’, access the tab ‘Radio’. On “Devices Info” it is possible to visualize the information that has been collected by the Gateway. The information displayed is Date and Time of the last telegram received, Radio Address, Device Type, last Signal Level received from all Endpoints and Repeaters that are communicating.
(active) and for how long. On this page, the SensusRF and the OMS protocol can be active on each antenna clicking on the check box of each protocol/antenna respectively. The image below illustrates the gateway default configuration, with only the SensusRF protocol enabled on the antenna 1.
12.3.1 External Sirt support The gateway supports up to two standard Sirt devices from Sensus to be connected to the gateway. If external Sirts are detected by the gateway at boot time, the Sirt Mode configuration page will display the external Sirts and allow their configuration.
NSTALLATION MODE NOTE For security reasons, if the SensusRF Gateway is left on ‘Installation Mode’ for more than 12 hours the gateway will disable it automatically returning to the Normal Mode. 13.1.2 Restarting the Gateway In order to restart (“reboot”) the Gateway it is necessary to access the tab “Advanced” and select the ‘Settings’...
13-2 - “G ” IGURE ATEWAY ESTART BUTTON 13.1.3 Resetting the Gateway In order to reset the Gateway to its default factory status, it is necessary to access the tab “Advanced” and select the ‘Settings’ option. To reset, just click on ‘Gateway Restart’ button and wait a few seconds to finish the process.
13.1.4 Password Changing On “Change Password” all user passwords can be changed. To do that, it is necessary to click on tab “Advanced” option “Settings”. The specific user needs to be selected and its Current Password provided, along with the New Password need to be provided.
13-5 – IGURE GATEWAY LOG MANAGEMENT 13.1.6 Support Services If the gateway is configured on the “Iris Light” mode, a new session is available on the “Settings” page. When enabled, this configuration allows the gateway to connect to a support Iris Server and a remote connection to the gateway can be established from that particular Iris Server.
13-6 – IGURE GATEWAY LIGHT SUPPORT SERVICE CONFIGURATION 13.1.7 Production mode During the production process, automated stages need to access the gateway intelligent block over the USB channel and this access is blocked by default. The “Production mode” switch allows this access for 24 hours or until the gateway is restarted.
13.1.8 Mobile mode The SensusRF gateway supports a new feature called Mobile Mode. In this mode, the gateway stores its internal data on an external sdcard to allow the gateway to be frequently turned on/off. This feature is intended for gateways applied on scenarios where it is not turned on 24x7, but instead it turns on and off regularly.
Page 63
sdcard slot And switch the Mobile button to ON. The gateway will reboot and display the status of the external sdcard. 13-9 – IGURE SDCARD STATUS If the Mobile Mode is enabled and the external sdcard is not available or damaged, the gateway will not collect and deliver readings.
13.3 VPN The SensusRF gateway can be configured as a client in a VPN infrastructure. This feature is based on openVPN software and configuring the VPN client in the gateway is a simple task, however this topic assumes the users have some basic knowledge about VPN, knowing how to create and setup a VPN client/server.
Page 65
• Enable or disable the VPN feature Load or delete the VPN configuration files • • Check the VPN status • Check the VPN client IP Address Check the VPN client logs • 13-13 – VPN CLIENT WEB PAGE IGURE A client configuration file named “vpn.ovpn”...
Page 66
IMPORTANT: for security reasons, the user cannot access VPN confirmation files after they are loaded in the gateway. This measure prevents unauthorized users to have access to the VPN client configuration files and later to the VPN server. Below an example of a simple client configuration file. The appropriated configuration depends on the VPN server requirements: client dev tun...
Once enabled, the VPN client logs will be populated. The “Refresh” button can be used to refresh the log content. If the client was properly configured, the VPN status will be green and the client IP address received in the VPN interface tunnel will be displayed. 13-17 –...
Page 68
To import back the configuration to a gateway, first a previously exported configuration file must be selected by clicking the “Select File”. After selecting the correct file, click the “Import” button. The configuration files will only be created by a gateway, an user will not be allowed to manually create or modify the configurations files to be imported.
13-20 – EXAMPLE OF ERROR IMPORTING A CONFIGURATION FILE DUE TO MISMATCHING FIRMWARE VERSION IGURE BETWEEN SOURCE AND TARGET GATEWAYS CONSIDERATIONS: 1. The certificate configuration will not be part of the export/import process as a certificate configuration mistake could lead to losing access to the gateway web page. If a certificate configuration is required, that is the only configuration that should be performed again by the user.
13-22 – S IGURE ERVICE ACCESS CONTROL OVER THE INTERFACE The client IP addresses or network range allowed to access the services could also be restricted. When the “IP access” field is left empty, all IP addresses can access the service over the allowed interfaces. When an IP address or network range is specified, only those will be able to access the service over the allowed interfaces.
Page 71
13-24 – T IGURE FACTOR AUTHENTICATION To enable this feature, a server and client certificates pair will be needed: • Server certificate: A private root certification authority (CA) is required for the Gateway. • Client certificate: A self signed client certificate (signed by the private CA above) is required for the client web browser.
• It is strongly recommended that the server CA + client certificate pair is tested and validated before enabling the Two-factor Authentication. 13.7 Audit It is possible to verify audit information on “Advanced”, “Certificate”. 13-26 – A IGURE UDIT Auditing is always enabled in the gateway and cannot be disabled. The gateway logs all configuration changes, gateway reboots, readings file downloads, user login/logout, and the last 500 events are stored.
Languages Currently, it is possible to select the language for English, Portuguese or German by clicking on “Languages”. The Figure 14-1 illustrates the option “Languages”. 14-1 - L IGURE ANGUAGES...
Logout To log out of the system, click the button “Logout” which is on the upper right corner of screen. The Figure 15-1 illustrates the location of the Logout link. 15-1 – L IGURE OGGING OUT OF THE GATEWAY...
SMS commands The SensusRF Gateway has a feature that allows the user to send commands via SMS. This is useful for situations where the user is not close to where the Gateway is installed. Firstly, in order to send a command to the Gateway it is necessary send the PIN command. The PIN command opens a session between the mobile phone and the Gateway.
Returns: ‘ACK’ (if the PIN number provided is correct) 16.2 “Gwcont” command The “gwcont” command is used for configure GPRS and server parameters. The syntax of the command is: gwcont,APN,IP,PORT,AUTHENTICATION,USER,PASS Where: APN is the carrier Access Point Name (APN) IP,PORT is the IRIS server IP and PORT the gateway will connect to AUTHENTICATION is the GPRS Authentication method: 0 (NONE), 1 (CHAP) or 2 (PAP).
16.3 “Ggwcont” command The “ggwcont” command requests the GPRS & server parameters of configured on the Gateway. The syntax of the command is: ggwcont Returns: GGWCONT,APN,IP,PORT,AUTHENTICATION,USER,PASS Where: APN is the carrier Access Point Name (APN) IP,PORT is the IRIS server IP and PORT the gateway will connect to AUTHENTICATION is the GPRS Authentication method: 0 (NONE), 1 (CHAP) or 2 (PAP).
16.5 “signal” command The “signal” command returns information to help with diagnostics of the state of communications with the gateway. Displays the current temperature and maximum temperature reached by the module among others information. The syntax to send the command is: signal Returns: Where:...
3 = successfully connected Usually, it is unlikely to see the states "1" and "2" because their transitions are fast. [0-1] - The availability status of the GPRS network in place This information is obtained from the GPRS network, and represents a reliable basis for determining whether or there is not any problem with the GPRS network in place (0 = GPRS not available, 1= GPRS available) 16.6 “gpppip”...
16.8 “vpn” command The “vpn” command enabled the VPN client in the gateway. All configuration files must be already loaded and tested in the gateway, this command will only allow the user to enable the VPN later on. vpn,[iris_server_ip_or_hostname,iris_server_port] Where: Iris_server_ip_or_hostname is the Iris Server the gateway will connect to Iris_server_port is the IRIS server PORT the gateway will connect to If the Iris server IP and Port is not provided, the gateway will use its internal configuration to try to...
APPENDIX A: GATEWAY REST API SPECIFICATION 17.1 Introduction This section describes the CAS GATEWAY REST API interface, which allows other systems to inquire for gateway sensors status and meter readings. 17.1.1 Glossary HTTP => Acronym for Hypertext Transfer Protocol. This is the communication protocol used as •...
17.2 HTTPS API: Methods Available For accessing the GATEWAY API it is necessary to inform the user credentials. The Gateway validates the username and password then generates a JWT, which is valid for seven days and exclusive for this specific gateway and session.
Page 83
17.2.1.1 Request REQUEST DESCRIPTION Scheme https://<GATEWAY IP>/api/auth HTTP Method POST Parameters Username; Password Example POST /api/auth HTTP/1.1 Content-Length: Host: 192.168.7.2 Content-Type: application/x-www-form-urlencoded username=admin&password=admin 17.2.1.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request The authorization token Example HTTP/1.1 200 OK...
"request_status":"OK", "jwt":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOiI wRkMzMTMwMTBGNjdDNkFFIiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjh DOkEwOkYzOjMxIiwibWFudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxN TY2NDE0NDgxfQ.0O0ThrpC5t8ys1To79r2tF1cGoHx5OnyJgu6_JRHmO4" 17.2.2 Read sensors status The “read sensors status” method returns a JSON embodying the GATEWAY Date and time, voltage, door sensor status and temperature information. The method must contain the JWS in its HTTP header as “Authorization”.
Page 85
17.2.2.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information datetime Gateway current date and time (yyyy-MM-dd hh:mm:ss) voltage Gateway instantaneous voltage door_sensor Gateway door sensor status (opened or closed) temperature Gateway temperature in Celsius degrees Example:...
17.2.3 Read datetime The “read datetime” method returns a JSON embodying the GATEWAY Date and time (yyyy-MM-dd hh:mm:ss). The method must contain the JWS in its HTTP header as “Authorization”. 17.2.3.1 Request REQUEST DESCRIPRION Scheme https://<GATEWAY IP>/api/info/datetime HTTP Method Parameters Authorization with JWT Example: GET /api/info/datetime HTTP/1.1...
RESPONSE DESCRIPTION payload The payload of the requested information datetime Gateway current date and time (yyyy-MM-dd hh:mm:ss) Example: HTTP/1.1 200 OK X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY Content-type: text/html; charset=UTF-8 Content-Length: Date: Sat, 01 Jan 2000 02:36:20 GMT "api_version":"1.0", "request_status":"OK", "payload":{ "datetime":"2000-01-01 02:36:20" 17.2.4 Read voltage The “read voltage”...
Page 88
17.2.4.1 Request REQUEST DESCRIPRION Scheme https://<GATEWAY IP>/api/info/voltage HTTP Method Parameters Authorization with JWT Example: GET /api/info/voltage HTTP/1.1 Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOiIyM0FFMTMw MTBGNjdGN0Y1IiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjhDOkEwOkYzOjMxIiwi bWFudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjo5NDcyOTgwMzl9.a-eaQz6-- ggaX8rZjPWLilQnjWfdnwqgqRMIDncs2tE Host: 192.168.7.2 17.2.4.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information voltage...
"api_version":"1.0", "request_status":"OK", "payload":{ "voltage":"12.1" 17.2.5 Read temperature The “read temperature” method returns a JSON embodying the GATEWAY temperature in Celsius degrees. The method must contain the JWS in its HTTP header as “Authorization”. 17.2.5.1 Request REQUEST DESCRIPTION Scheme https://<GATEWAY IP>/api/info/temperature HTTP Method Parameters Authorization with JWT...
Host: 192.168.7.2 17.2.5.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information temperature Gateway temperature in Celsius degrees Example: HTTP/1.1 200 OK X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY Content-type: text/html...
Page 91
17.2.6.1 Request REQUEST DESCRIPTION Scheme https://<GATEWAY IP>/api/info/door_sensor HTTP Method Parameters Authorization with JWT Example: GET /api/info/door_sensor HTTP/1.1 Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOiJDNzY2MTMw MTBGNjc4NjA5IiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjhDOkEyOkEzOjAyIiwibW FudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxNTY2NDk1NTIyfQ.3zcy7tIxe7otsjzU sLNy5ePAtE_oh26U5WIIqAnU4Hw Host: 192.168.7.2 17.2.6.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information door_sensor...
Example: HTTP/1.1 200 OK X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY Content-type: text/html Content-Length: Date: Thu, 15 Aug 2019 17:43:21 GMT "api_version":"1.0", "request_status":"OK", "payload":{ "door_sensor":"opened" 17.2.7 Read total number of OMS meters The “read total number of OMS meters” method returns a JSON embodying the total number of OMS meters the GATEWAY reads.
Page 93
REQUEST DESCRIPTION Parameters Authorization with JWT Example: GET /api/oms HTTP/1.1 Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOiJDNzY2MTMw MTBGNjc4NjA5IiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjhDOkEyOkEzOjAyIiwibW FudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxNTY2NDk1NTIyfQ.3zcy7tIxe7otsjzU sLNy5ePAtE_oh26U5WIIqAnU4Hw Host: 192.168.7.2 17.2.7.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information total_oms_endpoints Total number of OMS meters the GATEWAY reads Example:...
"total_oms_endpoints":"37" 17.2.8 Read total number of SensusRF meters The “read total number of SensusRF meters” method returns a JSON embodying the total number of SensusRF meters the GATEWAY reads. The method must contain the JWS in its HTTP header as “Authorization”.
The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information total_ sensusrf _endpoints Total number of SensusRF meters the GATEWAY reads. Example: HTTP/1.1 200 OK X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY...
Page 96
17.2.9.1 Request REQUEST DESCRIPTION Scheme https://<GATEWAY IP>/api/oms/list HTTP Method Parameters Authorization with JWT Example: GET /api/oms/list HTTP/1.1 Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOiJDNzY2MTMw MTBGNjc4NjA5IiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjhDOkEyOkEzOjAyIiwibW FudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxNTY2NDk1NTIyfQ.3zcy7tIxe7otsjzU sLNy5ePAtE_oh26U5WIIqAnU4Hw Host: 192.168.7.2 17.2.9.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information oms_endpoints...
Request list of Serial numbers of SensusRF meters The “request list of serial numbers of SensusRF meters” method returns a JSON embodying a list of serial numbers of SensusRF meters the GATEWAY reads. The method must contain the JWS in its HTTP header as “Authorization”.
Page 98
17.2.10.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information sensusrf_endpoints List of serial numbers of SensusRF meters the GATEWAY reads. Example: HTTP/1.1 200 OK...
X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY Content-type: text/html Content-Length: Date: Thu, 15 Aug 2019 19:46:40 GMT "api_version":"1.0", "request_status":"OK", "payload":{ "sensusrf_endpoints":[ "1031-000-0157", "1031-001-4248", "1011-000-0983", "1031-002-0143", "1011-000-8020", "1011-003-0767", "1031-002-0192", "1031-001-4251", "1401-000-2764", "1031-002-0193", "1011-000-2437", "1401-000-0646", "1031-001-4246", "1011-001-9658", "1031-002-0142", "1011-005-5216", "1031-000-0772", "1011-000-0981", "1031-007-1594", "1031-001-4249", "1011-003-0749", "1031-001-4240" 17.2.11 Request the latest encrypted packet for all OMS meters The “Request the latest encrypted packet for all OMS meters”...
Page 100
17.2.11.1 Request REQUEST DESCRIPTION Scheme https://<GATEWAY IP>/api/oms/all HTTP Method Parameters Authorization with JWT Example: GET /api/oms/all HTTP/1.1 Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOi JDNzY2MTMwMTBGNjc4NjA5IiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjhDOkEyO kEzOjAyIiwibWFudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxNTY2NDk1NTIyfQ.3 zcy7tIxe7otsjzUsLNy5ePAtE_oh26U5WIIqAnU4Hw Host: 192.168.7.2 17.2.11.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information oms_endpoints...
The “Request the latest encrypted packet for all SensusRF meters” method returns a JSON embodying the serial number, date and time, signal and last reading from each SensusRF meter the GATEWAY reads. The method must contain the JWS in its HTTP header as “Authorization”.
Page 102
17.2.12.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information sensusrf_endpoints List of last reading data from each SensusRF meter device_id SensusRF meter serial number...
Page 103
RESPONSE DESCRIPTION datetime SensusRF meter date and Time (yyyy-MM-dd hh:mm:ss) signal SensusRF meter signal level last_packet SensusRF meter last reading (raw/encrypted telegram) Example: HTTP/1.1 200 OK X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY Content-type: text/html Content-Length: 2761 Date: Thu, 15 Aug 2019 20:56:28 GMT "api_version":"1.0",...
17.2.13 Request the latest packet for a specific OMS meter The “Request the latest encrypted packet for a specific OMS meter” method returns a JSON embodying the serial number, date and time, signal and last reading of the OMS meter requested. The method must contain the JWS in its HTTP header as “Authorization”.
Page 105
17.2.13.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information oms_endpoints Reading data from the OMS meter requested device_id OMS meter serial number datetime OMS meter date and Time (yyyy-MM-dd hh:mm:ss) signal OMS meter signal level last_packet...
The “Request the latest encrypted packet for a specific SensusRF meter” method returns a JSON embodying the serial number, date and time, signal and last reading of the SensusRF meter requested. The method must contain the JWS in its HTTP header as “Authorization”.
Page 107
The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information sensusrf_endpoints Reading data from the SensusRF meter requested device_id SensusRF meter serial number datetime SensusRF meter date and Time (yyyy-MM-dd hh:mm:ss) signal...
17.2.15 Delete all OMS entries The “delete all OMS entries” method deletes all the OMS entries on GATEWAY. It returns a JSON embodying the request action and the status of the request. The method must contain the JWS in its HTTP header as “Authorization”.
17.2.16 Delete all SensusRF entries The “delete all SensusRF entries” method deletes all the SensusRF entries on GATEWAY. It returns a JSON embodying the request action and the status of the request. The method must contain the JWS in its...
Page 110
17.2.16.1 Request REQUEST DESCRIPTION Scheme https://<GATEWAY IP>/api/ep/all HTTP Method DELETE Parameters Authorization with JWT Example: DELETE /api/ep/all HTTP/1.1 Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOi JDNzY2MTMwMTBGNjc4NjA5IiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjhDOkEyO kEzOjAyIiwibWFudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxNTY2NDk1NTIyfQ.3 zcy7tIxe7otsjzUsLNy5ePAtE_oh26U5WIIqAnU4Hw Host: 192.168.7.2 17.2.16.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information action...
Example: HTTP/1.1 200 OK X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY Content-type: text/html Content-Length: Date: Thu, 15 Aug 2019 21:37:40 GMT "api_version":"1.0", "request_status":"OK", "payload":{ "action":"delete all ep", "status":"OK" 17.2.17 Delete specific OMS entry The “delete specific OMS entry” method deletes a specific OSM entry on the GATEWAY. It returns a JSON embodying the request action and the status of the request.
Page 112
17.2.17.1 Request REQUEST DESCRIPTION Scheme https://<GATEWAY IP>/api/oms/<serial> HTTP Method DELETE Parameters Authorization with JWT Example: DELETE /api/oms/00134524 HTTP/1.1 Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlfdmVyc2lvbiI6IjEuMCIsInNlc3Npb25faWQiOi JDNzY2MTMwMTBGNjc4NjA5IiwidXNlciI6ImFkbWluIiwibG9nZ2VkIjoidHJ1ZSIsIm1hYyI6IjFDOkJBOjhDOkEyO kEzOjAyIiwibWFudWZhY3RvciI6IkNBUyBURUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxNTY2NDk1NTIyfQ.3 zcy7tIxe7otsjzUsLNy5ePAtE_oh26U5WIIqAnU4Hw Host: 192.168.7.2 17.2.17.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information action...
17.2.18 Delete specific SensusRF entry The “delete specific SensusRF entry” method deletes a specific SensusRF entry on the GATEWAY. It returns a JSON embodying the request action and the status of the request. The method must contain the JWS in its HTTP header as “Authorization”.
Page 114
kEzOjAyIiwibWFudWZhY3RvciI6IkNBUyBURwUNOT0xPR0lBIiwiZXhwaXJhdGlvbl9kYXRlIjoxNTY2NDk1NTIyfQ. 3zcy7tIxe7otsjzUsLNy5ePAtE_oh26U5WIIqAnU4Hw Host: 192.168.7.2 17.2.18.2 Response RESPONSE DESCRIPTION api_version The version of the GATEWAY REST API request_status The status of the request payload The payload of the requested information action Action requested status Request status Example: HTTP/1.1 200 OK X-Powered-By: CAS_GATEWAY Server: CAS_GATEWAY...
APPENDIX B: GATEWAY HTTP/HTTPS SERVER REQUIREMENTS Gateway files can be delivered over Hyper Text Transfer Protocol (HTTP) / Hypertext Transfer Protocol Secure (HTTPS). All files are be sent in a single POST request, as ilustrated below: The following fields will be sent in the header structure: 1.
Page 116
Username: sensus • • Password: passwdtest The field's value is the base64-encoding of sensus:passwdtest or c2Vuc3VzOnBhc3N3ZHRlc3Q=. Then the Authorization header will appear as: Authorization: Basic c2Vuc3VzOnBhc3N3ZHRlc3Q=. The Server should validate the username and password and respond: HTTP 200 means configuration is OK ...
Page 117
Below details reagrding the request/reponse mechanism and the header/body filejds are ilusrtaed. Request/Response Request fields...
APPENDIX C: GATEWAY MIB FILE -- Copyright 2000-2020 CAS Tecnologia S/A. All Rights Reserved. -- cas.mib -- Management Information Base (MIB) for Gateway -- Version = 1.0 -- Patch Level = 00 CAS-GTW-MIB DEFINITIONS ::= BEGIN IMPORTS OBJECT-TYPE FROM RFC-1212 NOTIFICATION-TYPE FROM SNMPv2-SMI;...
Page 119
-- CAS Gateway Variables firmwareVersion OBJECT-TYPE SYNTAX DisplayString ACCESS read-only STATUS mandatory DESCRIPTION "Gateway Firmware Version." ::= { gwtAgent 1 } imei OBJECT-TYPE SYNTAX DisplayString ACCESS read-only STATUS mandatory DESCRIPTION "GPRS Modem International Mobile Equipment Identity (IMEI)." ::= { gwtAgent 2 } ssn1 OBJECT-TYPE SYNTAX DisplayString...
Page 120
ssn2 OBJECT-TYPE SYNTAX DisplayString ACCESS read-only STATUS mandatory DESCRIPTION "SIMCARD#2 (lower slot) serial SIM number (SSN)." ::= { gwtAgent 4 } connectionStatus OBJECT-TYPE SYNTAX DisplayString ACCESS read-only STATUS mandatory DESCRIPTION "Iris Server Connection Status." ::= { gwtAgent 5 } signal OBJECT-TYPE SYNTAX DisplayString ACCESS...
Page 121
STATUS mandatory DESCRIPTION "Battery/DC Power Supply voltage." ::= { gwtAgent 7 } macAddress OBJECT-TYPE SYNTAX DisplayString ACCESS read-only STATUS mandatory DESCRIPTION "Gateway MAC ADDRESS." ::= { gwtAgent 8 } -- CAS Gateway Traps startupAlarm NOTIFICATION-TYPE STATUS current DESCRIPTION "Gateway startup notification alarm." ::= { gwtTrap 1 } doorOpenAlarm NOTIFICATION-TYPE STATUS current...
Page 122
STATUS current DESCRIPTION "Gateway door closed notification alarm." ::= { gwtTrap 3 } batteryBelowLimitAlarm NOTIFICATION-TYPE STATUS current DESCRIPTION "Gateway battery/DC power supply voltage below limit notification alarm." ::= { gwtTrap 4 } batteryAboveLimitAlarm NOTIFICATION-TYPE STATUS current DESCRIPTION "Gateway battery/DC power supply voltage above limit notification alarm."...
Page 123
DESCRIPTION "Failed to deliver last email readings notification alarm." ::= { gwtTrap 8 } sdCardAlarm NOTIFICATION-TYPE STATUS current DESCRIPTION "Failed to use SD card notification alarm." ::= { gwtTrap 10 } testAlarm NOTIFICATION-TYPE STATUS current DESCRIPTION "Gateway test notification alarm." ::= { gwtTrapTest 1 }...
Page 124
Sensus reserves the rights to modify or to update the information, character and technical features described related to the product without previous notification.
Need help?
Do you have a question about the SensusRF and is the answer not in the manual?
Questions and answers