ABB G13 User Manual
  1. Manuals
  2. Brands
  3. ABB Manuals
  4. Gateway
  5. G13
  6. User manual

ABB G13 User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

G13
User Manual

Advertisement

Table of Contents
loading

Related Manuals for ABB G13

Summary of Contents for ABB G13

  • Page 1 User Manual...
  • Page 3 User Manual Document ID: 2CMC489001M0201 Revision: A 2013-04-25...
  • Page 4 ABB AB. ABB AB assumes no responsi- bility for any errors that may appear in this document. In no event shall ABB AB be liable for direct, indirect, special, incidental or con- sequential damages of any nature or kind arising from the use of this document, nor shall ABB AB be liable for incidental or consequential damages arising from use of any software or hardware described in this document.

  • Page 5: Table Of Contents

    6.3.11 GET /gateway/datetime ................... 71 6.3.12 POST /gateway/datetime ................. 72 6.3.13 GET /gateway/events ..................74 6.3.14 DELETE /gateway/events ................77 6.3.15 POST /gateway/reboot ..................77 6.3.16 POST /gateway/execute .................. 79 6.3.17 GET /users ....................... 81 2CMC484002M0201 G13 Revision A User Manual...
  • Page 6 Table of Content 6.3.18 POST /users/<user> ..................82 6.3.19 PUT /users ....................... 83 6.3.20 DELETE /users/<user> ..................84 6.3.21 GET /users/<user>/bindings ................85 6.3.22 PUT /users/<user>/bindings ................86 6.3.23 DELETE /users/<user>/bindings ..............87 6.3.24 GET /meters/firmwareupdatestatus ..............87 6.3.25 POST /firmware ....................89 6.3.26 PUT /firmware ....................
  • Page 7 6.3.86 POST /meters <serial> /tariff /weekprofiles ........... 232 6.3.87 GET /meters/<serial>/tariff/seasonprofiles ............ 234 6.3.88 POST /meters/<serial>/tariff/seasonprofiles ..........236 6.3.89 GET /meters/<serial>/tariff/specialdayprofiles ..........238 6.3.90 POST /meters/ <serial>/tariff/specialdayprofiles ..........240 6.3.91 GET /lasterror/<id> ..................242 6.3.92 Annexure1 ..................... 243 2CMC484002M0201 G13 Revision A User Manual...
  • Page 8 Table of Content 2CMC484002M0201 User Manual Revision A...

  • Page 9: Product Overview

    LEDs. In this chapter The following topics are covered in this chapter: 1.1 The Parts of the Gateway ..............6 1.2 The Parts of the Web Interface .............. 8 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 10: The Parts Of The Gateway

    Product Overview 1.1 The Parts of the Gateway The parts of the Gateway are shown in the illustration below: Illustration G 1 3 1 0 0 - 0 0 0 WP AN A RS 48 5 W PA N R E S E Parts description The following table describes the parts of the Gateway: Item...
  • Page 11 LED B - Wired meter connection status Communication Idle Steady green Data Transfer Continuous flashing green Connection error LED C - Wireless meter connection status Communication Idle Steady green Data Transfer Continuous flashing green 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 12: The Parts Of The Web Interface

    Product Overview 1.2 The Parts of the Web Interface The parts of the web interface are shown in the illustration below: Illustration Parts description The following table describes the parts of the web interface: Item Part Comments Location The presently selected location (Group of Meters) Meters in location Number of meters associated with the present lo-...

  • Page 13: Installation

    Installation Chapter 2: Installation Overview This chapter describes how to mount and connect the G13 gateway to an electricity network. In this chapter The following topics are covered in this chapter: 2.1 Installing the Gateway ................. 10 2.1.1 Wiring Diagrams ................ 11 2CMC489001M0201 G13...

  • Page 14: Installing The Gateway

    Connect the cables according to the marking on the product label and tighten the screws (0.5 Nm). Install the circuit protection (max. 50 A). Turn on the power. Verify that LED A shines steady green. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 15: Wiring Diagrams

    100 - 240 VAC RS-485 RS-485 Note – For RS-485, signal A should be wired to A on the meter and equivalent for signals B and C. M-Bus M-Bus Wiring of M-Bus is polarity independent Note – 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 16: Technical Data

    This chapter contains the technical specifications and the physical dimensions of the product. In this chapter The following topics are covered in this chapter: 3.1 Technical Specifications ..............13 3.2 Physical Dimensions ................15 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 17: Technical Specifications

    Technical Data 3.1 Technical Specifications Specifications for G13 Ethernet gateway Power supply Voltage 100 - 240 V AC (-20% - +15%) Fuse 0.5 - 80 A Frequency 50 or 60 Hz ± 5% Power consumption in standby 10 W Power consumption in operation Max.
  • Page 18 Technical Data Protection class Class II (double isolation) IP Class IP 20 Default IP address https://192.168.1.12 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 19: Physical Dimensions

    Technical Data 3.2 Physical Dimensions The following drawing shows the physical dimensions of the G13 gateway in 41.50 2CMC489001M0201 User Manual Revision: A...

  • Page 20: User Interface And Setup

    4.3 Firmware update .................. 25 4.4 Device Registration ................27 4.5 Connect a meter via the Energy Meter Gateway interface ....28 4.5.1 Scan meter ................. 29 4.5.2 Add scanned meter ..............31 4.5.3 User Management ..............31 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 21: User Interface

    From the web interface it is possible to configure meters. The Home menu displays the connected meters. Home Menu To access the Home menu: 1. Click Home in the menu bar. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 22 To access the Segment menu: 1. Click the Segment button in the menu bar. The Location menu shows the following options: Location menu To access the Location menu: 1. Click Location in the menu bar. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 23 1. Click Meter in the menu bar. The Events menu shows the Gateway events: Events menu To access the Events menu: 1. Click Events in the menu bar. To reset the Gateway Events: 1. Click Reset. About menu 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 24 • Serial No • JSON API Version • COSEM Version • Logical Device Name • Release Date • Licenses • RAM Usage To access the About menu: 1. Click About in the menu bar. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 25: Gateway Settings

    Gateway settings The basic settings for the Gateway consists of the following: • Gateway Date / Time • Gateway Alias • IP Configuration • RS-485 Configuration Note – Only Gateway admin can change Gateway Settings. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 26 Location To set the Gateway Alias and Gateway Location: 1. Click in the Gateway Alias field and set the name. 2. Click on the Gateway Location field and set the name. 3. Click Send. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 27 1. Check the radio button Obtain DNS server address automatically. 2. Click Send. To set DNS server addresses: 1. Check the radio button Use the following DNS addresses. 2. Click the IP address field. 3. Set the IP address. 4. Click Send. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 28 User Interface and Setup RS-485 Bus The baudrate is set to 500000 by default for RS-485 Bus. Configuration To set the baudrate: 1. Select baudrate. 2. Click Send. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 29: Firmware Update

    3. Click on Choose file and browse for preferred firmware version. 4. Click on Transfer image. The firmware is now sent to the gateway. 5. Click on Update firmware. The Gateway firmware will now be updated. Meter firmware 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 30 5. Click on Transfer image. The firmware is now sent to the gateway. 6. Click on Update firmware. The Meter firmware will now be updated on the chosen meters. Note – Maximum number of ten meters can be updated at the same time. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 31: Device Registration

    2. Click Device Registration. 3. Click Refresh to update available meters. 4. Click on the field below ABB, named Unknown in the image above. Set location name of the meter. 5. Click in the field below, named ABB01EM000014522 in the image above.

  • Page 32: Connect A Meter Via The Energy Meter Gateway Interface

    Username: admin 2. Password: admin 3. Click Login. Gateway will automatically prompt for change of password at first login. Internet browser will warn for unsafe security since the Gateway certificate is self-issued by ABB. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 33: Scan Meter

    Scan new meter with EQ bus To scan a meter with EQ bus. 1. Check the EQ bus box. 2. Check radio button Start, end addresses or Specific addresses 3. Set specific address/addresses. 4. Press Scan. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 34 M-Bus IR Scan and add a via M-Bus IR: 1. Check the M-Bus IR box. 2. Check Primary Address or Secondary Address radio button. 3. Select corresponding baudrate to the meter. 4. Press Scan. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 35: Add Scanned Meter

    • No Access - No access to read or configure the meter. • View only - Possible to view values from the meter. • Configure - Full rights to configure the meter. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 36 Add meter admin access To add meter admin access to a user: 1. Click Segment menu. 2. Click User Management. 3. Click User. 4. Select location. 5. Select access. 6. Click Send. Set Password 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 37 2. Select User Management. 3. Set current password in Current Password field. 4. Set the new password in the Password field. 5. Confirm the new password in Confirm Password field. 6. Click Send. Add User 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 38 5. Set the password in the Password field. 6. Confirm the password in the Confirm Password field. 7. Select Access level to preferred meters. 8. Click Send. Note – Username must only consist of lowercase letters and numbers from 0-9. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 39: Meter Settings

    5.1.2 Previous Value Configuration ............ 39 5.1.3 Load Profile Configuration ............40 5.1.4 Demand Configuration ............... 41 5.1.5 Tariff Configuration ..............42 5.1.6 Input/ Output Configuration ............44 5.1.7 Pulse Output Configuration ............45 5.1.8 Alarm Configuration ..............47 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 40: Setting And Configuration

    1. Select General Settings from the Meter Menu. 2. Scroll down to Ratio Settings. 3. Set the CT/VT ratio by entering the Numerator and Denominator fields (For example: 20 / 1 or 100 / 5 ) 4. Click Send. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 41 To set the Active tariff in a meter, perform the following steps 1. Select Meter Menu. 2. Select General Settings and scroll down to Tariff Settings. 3. Select Tariff Source from drop-down menu. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 42 To reset registers, perform the following steps: 1. Select General Settings from the Meter Menu. 2. Scroll down to Resettable Energy Settings. 3. Select energy setting to reset. 4. Click Reset. 5. Click Send. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 43: Previous Value Configuration

    The period options are: • Daily • Weekly • Monthly 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 44: Load Profile Configuration

    To configure a value for a channel: 1. Choose a channel from the Configured Channels list. 2. Select Period. 3. Select Storage items. 4. Select a value from the options list. 5. Click OK. 6. Click Send. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 45: Demand Configuration

    Note that sub-interval 2 is not available for interval 1-15 minutes, since 15 is not even dividable with 2. Each channel is separately configurable from the option window located to the right. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 46: Tariff Configuration

    16 day profiles. Remember to Save and Send. The Week tab Within the Week tab each day of a selected week can be set to either a Week Day or a Week End. Remember to Save and Send. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 47 Meter Settings The Season tab Within the Season tab Season Profiles can be configured. Remember to Save and Send. The Special Day 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 48: Input/ Output Configuration

    Meter Settings Within the Special Day tab Special Day Profiles can be configured. Re- member to Save and Send. 5.1.6 Input/ Output Configuration 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 49: Pulse Output Configuration

    2. Select a value from the option list located to the right. 3. Click OK. 4. Click Send. 5.1.7 Pulse Output Configuration 1. To configure Output line: 2. Select Port from 1- 4. 3. Set Pulse Length. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 50 Meter Settings 4. Set Frequency. 5. Select Energy Type. 6. Click Send. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 51: Alarm Configuration

    6. Set Off Delay to set the time for the alarm to turn off. 7. Check the Log box to log the alarms. 8. Select an Output between 1-4. 9. Click OK. 10.Click Send. 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 52: Json Communication

    This chapter will address communication using the JSON protocol. Overview In this chapter The following topics are covered in this chapter: 6.1 About JSON ..................47 6.2 Table of Resources ................50 6.3 Resources ................... 53 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 53: About Json

    The intended target groups for this chapter are user interface developers and API Target Groups consumers. Introduction This is a reference document for RESTful JSON API v1.0(Draft) of ABB Energy Meter Gateway 1.0. Current version of API supports following HTTP verbs • HTTP GET •...
  • Page 54 GET requests response may include valid data or status message. In case of update (POST, POST, DELETE) requests, the response would always be status message. Format of status message is {"status":"error","des":"URI not found."}. 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 55 JSON Communication Where field might include • status error success includes context specific message • When body of POST request includes multiple transactions, result is de- rived as success when all transactions succeed. Else result would be error and description includes transaction reference at which the POST opera- tion is aborted.

  • Page 56: Table Of Resources

    DELETE /users/<user> GET /users/<user>/bindings PUT /users/<user>/bindings DELETE /users/<user>/bindings GET /meters/firmwareupdatestatus POST /firmware PUT /firmware PUT /meters/firmware GET /parametermapping GET /storablequantities GET /meters/<serial>/associationobjects GET /meters POST /meters/<serial> PUT /meters DELETE /meters/<serial> GET /meters/scanned POST /meters/scanned/<token> 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 57 JSON Communication Resource DELETE /meters/scanned GET /permittedmeters PUT /permittedmeters DELETE /permittedmeters GET /meters/<serial>/datetime POST /meters/<serial>/datetime GET /meters/<serial>/info GET /meters/<serial>/energy/conversionfactor POST /meters/<serial>/energy/conversionfactor GET /meters/<serial>/hardwareversion GET /meters/<serial>/mbusinfo POST /meters/<serial>/transformersettings GET /meters/<serial>/status GET /meters/<serial>/statusflags GET /meters/<serial>/events/<datetime>/<count> GET /meters/<serial>/alarms/configuration POST /meters/<serial>/alarms/configuration GET /meters/<serial>/energy/<type> GET /meters/<serial>/energy/<type>/<mode> GET /meters/<serial>/energy/resettable POST /meters/<serial>/energy/resettable GET /meters/<serial>/energy/resetcounter...
  • Page 58 JSON Communication Resource GET /meters/<serial>/demand/configuration POST /meters/<serial>/demand/configuration DELETE /meters/<serial>/demand/ GET /meters/<serial>/tariff POST /meters/<serial>/tariff GET /meters/<serial>/tariff/dayprofiles POST /meters/<serial>/tariff/dayprofiles GET /meters/<serial>/tariff/weekprofiles POST /meters/<serial>/tariff/weekprofiles GET /meters/<serial>/tariff/seasonprofiles POST /meters/<serial>/tariff/seasonprofiles GET /meters/<serial>/tariff/specialdayprofiles POST /meters/<serial>/tariff/specialdayprofiles GET /lasterror/<id> 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 59: Resources

    JSON Communication 6.3 Resources 6.3.1 GET /about A GET call to /about returns version information of key components of the gate- way. Protected Request GET /about HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/about Response • 200 Successful HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked...

  • Page 60: Post /Login

    A successful response to be considered as valid login session. If user did not change default password, provided by administrator, then server will respond with 403 Forbidden. In such case user is expected to set password before proceeding with other operations. JSON API users must call 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 61: Post /Logout

    JSON Communication [POST] /login with 'oldkey' and 'key' tags as shown below. Also users can explicitly logout of a session. https://192.168.1.12/login "name": "Username1", "oldkey": "user1234", "key": "user4321" Description • name [String(16)] - Username. • oldkey [String(32)] - Current password of user. •...

  • Page 62: Get /Configuration

    A GET call to /configuration returns TCP/IP settings, backplane settings and backplane timeouts (EQ bus, M-Bus Wired and M-Bus IR). Yes (Authentication required) Protected Request GET /configuration HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Example • https://192.168.1.12/configuration 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 63 JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "ip": { "dhcp": false, "dns": false, "gateway": "192.168.1.1", "ip": "192.168.1.12", "mac": "255.255.255.199.34.0", "pdns": "0.0.0.0", "sdns": "0.0.0.0", "subnet": "255.255.255.0" "eqbus": { "baudrate": 500000, "interoctettimeout": 40 "mbus-wired": { "ack": 1000, "delay_after_telegram": 1000,...

  • Page 64: Post /Configuration/Ip

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.5 POST /configuration/ip A POST call to /configuration/ip sets IP settings. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 65 JSON Communication Request POST /configuration/ip HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 179 "ip":"192.168.1.12", "dhcp":false, "dns":false, "gateway":"192.168.1.1", "subnet":"255.255.255.0", "pdns":"192.168.1.2" "sdns":"192.168.1.2" Description • dhcp [bool] : Value of false means static ip setting and value of true means dynamic ip from dhcp server •...

  • Page 66: Post /Configuration/Eqbus

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.6 POST /configuration/eqbus A POST call to /configuration/eqbus sets settings for eqbus backplane. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 67 JSON Communication Request POST /configuration/eqbus HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 46 "baudrate": 500000, "interoctettimeout": 1000 Description [Int]: Supported baudrates are listed below • baudrate 1200 2400 9600 19200 38400 57600 115200 125000 230400 460800 500000 interoctettimeout[Int] : should be in between 20 and 6000 seconds. •...

  • Page 68: Post /Configuration/Mbus-Wired

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.7 POST /configuration/mbus-wired A POST call to /configuration/mbus-wired sets timeout parameters for mbus- wired backplane. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 69 JSON Communication Request POST /configuration/mbus-wired HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 186 "ack": 250, "delay_after_telegram": 100, "delay_before_requd2": 100, "get_request": 200, "meter_contact": 150, "response_timeout": 300, "response_timeout_base": 100 Description timeout values are expressed in seconds. • • ack: value should be between 200 and 2000 •...

  • Page 70: Post /Configuration/Mbus-Ir

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.8 POST /configuration/mbus-ir A POST call to /configuration/mbus-ir sets timeout parameters for IR interface. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 71 JSON Communication Request POST /configuration/mbus-ir HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 186 "ack": 250, "delay_after_telegram": 100, "delay_before_requd2": 100, "get_request": 200, "meter_contact": 150, "response_timeout": 300, "response_timeout_base": 100 Description • timeout values are expressed in seconds. • ack: value should be between 200 and 2000 •...

  • Page 72: Get /Gateway

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.9 GET /gateway A GET call to /gateway returns alias, location and serial. Yes (Authentication required) Protected Request GET /gateway HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Example • https://192.168.1.12/gateway 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 73: Post /Gateway

    JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "alias":"Gateway", "location":"All Location", "serial":"ABBXXXXXXXXXXXX01" Description alias [String 21] - Gateway alias. • • location [String 51] - Location of gateway. • serial [String 17] - Serial of gateway. •...
  • Page 74 "serial": "ABBXXXXXXXXXXXX01", "alias": "Gateway", "location": "All Location" Description alias [String 21] - Gateway alias. • • location [String 51] - Location of gateway. • serial [String 17] - Serial of gateway. Examples • https://192.168.1.12/gateway 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 75: Get /Gateway/Datetime

    JSON Communication • 200 Success Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} • 400 Bad Request HTTP/1.1 400 Bad Request Server: embOS/IP Accept-Ranges: bytes Content-Length: 57 Content-Type: application/json "status":"error", "des":"missing datetime tag in JSON ." •...

  • Page 76: Post /Gateway/Datetime

    Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.12 POST /gateway/datetime A POST call to /gateway/datetime sets specified date and time in standard date time format (YYYY-MM-DDTHH:MM:SS) Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 77 JSON Communication Request POST /gateway/datetime HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 34 {"datetime":"2012-05-09T16:30:52"} Description Datetime[String]: Gateway date and time • Example • https://192.168.1.12/gateway/datetime 2CMC489001M0201 User Manual Revision: A...

  • Page 78: Get /Gateway/Events

    "des":"received invalid response from COSEM." 6.3.13 GET /gateway/events A GET call to /gateway/events returns the events log recorded by the gateway. Yes (Authentication required) Protected Request GET /gateway/events HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Example • https://192.168.1.12/gateway/events 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 79 JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "events":[ {"category":4,"index":6,"id":9,"timestamp":"2012- 05-17T13:02:02","type":2}, {"category":8,"index":5,"id":4,"timestamp":"2012- 05-17T12:02:02","type":2}, {"category":8,"index":4,"id":4,"timestamp":"2012- 05-17T12:02:02","type":2}, {"category":8,"index":3,"id":4,"timestamp":"2012- 05-17T12:02:02","type":2}, {"category":4,"index":2,"id":9,"timestamp":"2000- 01-01T00:02:02","type":2}, {"category":8,"index":1,"id":6,"timestamp":"2000- 01-01T00:02:02","type":2} 2CMC489001M0201 User Manual Revision: A...
  • Page 80 Firmware upload to Gateway completed GW_LD_FW_UPLOAD_FAIL Firmware upload to Gateway failed GW_FW_UPGRADE_START Gateway Firmware upgrade started GW_FW_UPGRADE_COMPLETE Gateway Firmware upgrade completed GW_FW_UPGRADE_FAIL Gateway Firmware upgrade failed LD_FW_UPGRADE_START Upgrade firmware to Logical device started LD_FW_UPGRADE_COMPLETE Upgrade firmware 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 81: Delete /Gateway/Events

    JSON Communication to Logical device complete LD_FW_UPGRADE_FAIL Upgrade firmware to Logical device failed • timestamp[String]: timestamp when event occurred • type[Int]: Type of event occurred 0 # Empty 1 # System 2 # Event 3 # Audit 4 # Quality 5 # Communication 6 # Transformer Ratio 6.3.14 DELETE /gateway/events...
  • Page 82 Content-Length: 51 Content-Type: application/json "status": "error", "des": "Forbidden. Access Denied" • 500 Internal Server Error HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 63 Content-Type: application/json "status":"error", "des":"Inetrnal Server Error. Reboot failed." 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 83: Post /Gateway/Execute

    JSON Communication 6.3.16 POST /gateway/execute A POST call to /gateway/execute executes Gateway command to read the param- eters supported as below (for the given OBIS and interface class id). VOLTAGE, CURRENT, ACTIVE_POWER, REACTIVE_POWER, APPARENT_POWER, ACTIVE_ENERGY_IMPORT, ACTIVE_ENERGY_EXPORT, ACTIVE_ENERGY_NET, REACTIVE_ENERGY_IMPORT, REACTIVE_ENERGY_EXPORT, REACTIVE_ENERGY_NET, APPARENT_ENERGY_IMPORT, APPARENT_ENERGY_EXPORT, APPARENT_ENERGY_NET, POWER_FACTOR, Differential VOLTAGE, PHASE_ANGLE_POWER, PHASE_ANGLE...
  • Page 84 • obis OBIS type can be an array of integers or String[23]. To read VOLTAGE_L1: The payload will be "devices": ["ABB01","ABB02"], "obis": [1,0,32,7,0,255], "classid": 3, "attributes": [2,3] To read POWERFACTOR_L1: The payload will be "devices": ["ABB01","ABB02"], "obis": [1,0,33,7,0,255], "classid": 3, "attributes": [2] Example • https://192.168.1.12/gateway/execute 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 85: Get /Users

    JSON Communication • 200 Success Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 To read 'VOLTAGE' of L1 , the response is as below: { "ABB01":["200.0","V"], "ABB02":["200.0","V"] } To read POWRFACTOR_L1, the response is as below: { "ABB01": ["0.9"], "ABB02": ["1.0"] } Description ABB01 or ABB02 is device serial name.

  • Page 86: Post /Users/

    POST /users/user HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 32 {"name":"Username1","oldkey":"user1234","key":"user4321"} Description name [String] - Username. • oldkey [String] - Current password of user. • key [String] - New password of user. • Examples • https://192.168.1.12/users/user3 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 87: Put /Users

    JSON Communication 200 Success • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} Notes In case of discrepancy with username field specified in URI and payload, data specified in payload takes precedence. 400 Bad Request • HTTP/1.1 400 Bad Request Server: embOS/IP Accept-Ranges: bytes...

  • Page 88: Delete /Users/

    {"status":"success"} 6.3.20 DELETE /users/<user> A DELETE call to /users/<user> removes specified user. Yes (Authentication required) Protected Request DELETE /users/<user> HTTP/1.1 Host: 192.168.1.12 Content-Type: application/json; charset=UTF-8 Authorization: Basic XXXXXXXXXXXXXXX= Content-Length: 17 {"name":"harsha"} Examples • https://192.168.1.12/users/harsha 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 89: Get /Users//Bindings

    JSON Communication 200 Success • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} 6.3.21 GET /users/<user>/bindings A GET call to /users/<user>/bindings returns list of access levels configured by administrator. Yes (Authentication required) Protected Request GET /users/<user>/bindings HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples •...

  • Page 90: Put /Users//Bindings

    Yes (Authentication required) Request PUT /users/<user>/bindings HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type: application/json; charset=UTF-8 Content-Length: 57 {"name":"harsha","serial":"ABB_3","access":"Config- ure"} Examples • https://192.168.1.12/users/harsha/bindings 200 OK Response • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 91: Delete /Users//Bindings

    JSON Communication 6.3.23 DELETE /users/<user>/bindings A DELETE call to /users/<user>/bindings removes user binding for reqeusted device. Protected Yes (Authentication required) Request DELETE /users/<user>/bindings HTTP/1.1 Content-Type: application/json; charset=UTF-8 Authorization: Basic XXXXXXXXXXXXXXX= Content-Length: 57 {"name":"harsha","serial":"ABB_3","access":"No Access"} Example • https://192.168.1.12/users/harsha/bindings 200 Success Response •...
  • Page 92 1 - update is in progress. 2 - update completed. • 500 Internal Server Error HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 93: Post /Firmware

    JSON Communication 6.3.25 POST /firmware A POST call to /firmware uploads image file to gateway. Image file can be of meter or gateway. At any time only one image file can be stored in gateway. Protected Yes (Authentication required) Request POST /firmware HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json...

  • Page 94: Put /Firmware

    "des":"received invalid response from COSEM." 6.3.26 PUT /firmware A PUT call to /firmware will update the firmware of gateway. Protected Yes (Authentication required) Request PUT /firmware/ HTTP/1.1 Host: 192.168.1.12 Authorization: Basic XXXXXXXXXXXXXXX= Example • http://192.168.1.12/firmware 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 95: Put /Meters/Firmware

    JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: text/html;charset=utf-8 Content-Length: 20 Connection: Keep-Alive {"status":"success"} 6.3.27 PUT /meters/firmware A PUT call to /meterfirmware updates meter firmware for requested set of meters. Note Applicable firmware image should be in gateway. Please refer to "POST /firm- ware"...

  • Page 96: Get /Parametermapping

    6.3.28 GET /parametermapping A GET call to /parametermapping returns the mapping list to be used as a refer- ence for configuring parameters in other URIs like configuration of complex pa- rameters. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 97 JSON Communication Request GET /parametermapping Authorization: Basic XXXXXXXXXXXXXXX= Examples • http://192.168.1.12/parametermapping 2CMC489001M0201 User Manual Revision: A...
  • Page 98 "17": "REACTIVE_ENERGY_IMPORT_TAR1", "18": "REACTIVE_ENERGY_IMPORT_TAR2", "19": "REACTIVE_ENERGY_IMPORT_TAR3", "20": "REACTIVE_ENERGY_IMPORT_TAR4", "21": "REACTIVE_ENERGY_IMPORT_TOTAL", "22": "REACTIVE_ENERGY_EXPORT_TOTAL", "23": "REACTIVE_ENERGY_IMPORT_L1", "24": "REACTIVE_ENERGY_IMPORT_L2", "25": "REACTIVE_ENERGY_IMPORT_L3", "26": "REACTIVE_ENERGY_EXPORT_L1", "27": "REACTIVE_ENERGY_EXPORT_L2", "28": "REACTIVE_ENERGY_EXPORT_L3", "29": "REACTIVE_ENERGY_NET_TOTAL", "30": "REACTIVE_ENERGY_NET_L1", "31": "REACTIVE_ENERGY_NET_L2", "32": "REACTIVE_ENERGY_NET_L3", "33": "APPARENT_ENERGY_IMPORT_TOTAL", 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 99 JSON Communication "34": "APPARENT_ENERGY_EXPORT_TOTAL", "35": "APPARENT_ENERGY_IMPORT_L1", "36": "APPARENT_ENERGY_IMPORT_L2", "37": "APPARENT_ENERGY_IMPORT_L3", "38": "APPARENT_ENERGY_EXPORT_L1", "39": "APPARENT_ENERGY_EXPORT_L2", "40": "APPARENT_ENERGY_EXPORT_L3", "41": "APPARENT_ENERGY_NET_TOTAL", "42": "APPARENT_ENERGY_NET_L1", "43": "APPARENT_ENERGY_NET_L2", "44": "APPARENT_ENERGY_NET_L3", "51": "IO_INPUT_CUMULATION_1", "52": "IO_INPUT_CUMULATION_2", "53": "IO_INPUT_CUMULATION_3", "54": "IO_INPUT_CUMULATION_4", "55": "IO_STORED_INPUT_STATE_1", "56": "IO_STORED_INPUT_STATE_2", "57": "IO_STORED_INPUT_STATE_3", "58": "IO_STORED_INPUT_STATE_4", "59": "THD_VOLTAGE_L1", "60": "THD_VOLTAGE_L2", "61": "THD_VOLTAGE_L3",...
  • Page 100 "111": "LOAD_PROFILE_CH_1", "112": "ALARM_SETTINGS_1", "113": "NRG_ENERGY_VALUE_CURR", "114": "TARIFF_CALENDAR_CONFIG", "115": "TARIFF_SPECIAL_DAYS_CONFIG", "116": "IO_SETTING", "117": "IO_PULSE_LENGTH_1", "118": "SYSTEM_STATUS_ERROR", "119": "SYSTEM_STATUS_WARNING", "120": "SYSTEM_STATUS_INFO", "121": "LOG_SYSTEM", "122": "NRG_ENERGY_VALUE_CO2", "123": "LOG_EVENT", "124": "LOG_QUALITY", "137": "SERIAL_NR", "138": "TYPE_DESIGNATION", "139": "FIRMWARE_VERSION", 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 101 JSON Communication "140": "HARDWARE_VERSION_0", "141": "TRAFO_CT_RATIO_NUMERATOR", "142": "TRAFO_CT_RATIO_DENOMINATOR", "143": "TRAFO_VT_RATIO_NUMERATOR", "144": "TRAFO_VT_RATIO_DENOMINATOR", "146": "CLOCK", "149": "TARIFF_ACTIVE_DAY_TYPE", "150": "TARIFF_ACTIVE_SEASON", "151": "POWER_OUTAGE_TIME", "152": "POWER_FAIL_COUNTER", "156": "HDLC_SLAVE_BACKPLANE_1", "158": "PHASE_ANGLE_VOLTAGE_L1", "159": "PHASE_ANGLE_CURRENT_L1", "160": "CURRENT_QUADRANT_L1", "161": "PHASE_ANGLE_VOLTAGE_L2", "162": "PHASE_ANGLE_CURRENT_L2", "163": "CURRENT_QUADRANT_L2", "164": "PHASE_ANGLE_VOLTAGE_L3", "165": "PHASE_ANGLE_CURRENT_L3", "166": "CURRENT_QUADRANT_L3", "169": "CURRENT_QUADRANT_TOTAL", "170": "FREQUENCY",...

  • Page 102: Get /Storablequantities

    A GET call to /storablequantities returns the list of configurable parameters for storing in meter. This is a generic list which is used for stored value channel configuration. Protected Yes (Authentication required) Request GET /storablequantities Authorization: Basic XXXXXXXXXXXXXXX= Examples storablequantities • http://192.168.1.12/ 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 103 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "pv": [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19, 21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,3 7,38,39,40, 41,42,43,44,51,52,53,54,113,122,85,86,87,88,89,90 ,91,92,171,172,173,174], "lp":[1,2,3,4,5,6,7,8,21,22,23,24,25,26,27,28,33, 34,35,36,37,38,39,40, 51,52,53,54,113,122,69,70,71,72,73,74,75,76,77,78 ,79,80,81,82,179,180, 181,182,183,184,185,186,187,188], "dm":[51,52,53,54,59,60,61,62,63,64,65,66,67,68,6 9,70,72,73,75,76,78,79,80, 81,93,94,95,96,97,98,99,100,101,102,103,104], "ac":[59,60,61,62,63,64,65,66,67,68,69,70,71,72,7 3,74,75,76,77,78,79,80, 81,82,93,94,95,96,97,98,99,100,101,102,103,104] 500 Internal Server Error • HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64...

  • Page 104: Get /Meters//Associationobjects

    A GET call to /meters/<serial>/associationobjects returns list of bitstring and re- spective access rights for given meter. Readers to note that access rights presented here are nothing to do with access level of gateway. These are access levels as is 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 105 JSON Communication in meter firmware. However gateway admin might impose access restrictions up above these for a given user. Association objects can be used to check if a given parameter is supported by meter or not. Say to know if a meter supports Read Active Export energy, then the following procedure can be followed: 1.
  • Page 106 APPARENT_ENERGY_NET_L2 APPARENT_ENERGY_NET_L3 IO_PULSE_LENGTH_2 IO_PULSE_LENGTH_3 IO_PULSE_LENGTH_4 IO_PULSE_FREQUENCY_AE_1 IO_PULSE_FREQUENCY_AE_2 IO_PULSE_FREQUENCY_AE_3 IO_INPUT_CUMULATION_1 IO_INPUT_CUMULATION_2 IO_INPUT_CUMULATION_3 IO_INPUT_CUMULATION_4 IO_STORED_INPUT_STATE_1 IO_STORED_INPUT_STATE_2 IO_STORED_INPUT_STATE_3 IO_STORED_INPUT_STATE_4 THD_VOLTAGE_L1 THD_VOLTAGE_L2 THD_VOLTAGE_L3 THD_VOLTAGE_L1_L2 THD_VOLTAGE_L2_L3 THD_VOLTAGE_L1_L3 THD_CURRENT_L1 THD_CURRENT_L2 THD_CURRENT_L3 THD_CURRENT_NEUTRAL VOLTAGE_L1 CURRENT_L1 POWER_FACTOR_L1 VOLTAGE_L2 CURRENT_L2 POWER_FACTOR_L2 VOLTAGE_L3 CURRENT_L3 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 107 JSON Communication POWER_FACTOR_L3 VOLTAGE_L1_L2 VOLTAGE_L2_L3 VOLTAGE_L1_L3 CURRENT_NEUTRAL POWER_FACTOR_TOTAL NRG_CONVERSION_FACTOR_CURR NRG_CONVERSION_FACTOR_CO2 ACTIVE_ENERGY_EXPORT_TAR1 ACTIVE_ENERGY_EXPORT_TAR2 ACTIVE_ENERGY_EXPORT_TAR3 ACTIVE_ENERGY_EXPORT_TAR4 REACTIVE_ENERGY_EXPORT_TAR1 REACTIVE_ENERGY_EXPORT_TAR2 REACTIVE_ENERGY_EXPORT_TAR3 REACTIVE_ENERGY_EXPORT_TAR4 ACTIVE_POWER_L1 ACTIVE_POWER_L2 ACTIVE_POWER_L3 ACTIVE_POWER_TOTAL REACTIVE_POWER_L1 REACTIVE_POWER_L2 REACTIVE_POWER_L3 REACTIVE_POWER_TOTAL APPARENT_POWER_L1 APPARENT_POWER_L2 APPARENT_POWER_L3 APPARENT_POWER_TOTAL PHASE_ANGLE_POWER_L1 PHASE_ANGLE_POWER_L2 PHASE_ANGLE_POWER_L3 PHASE_ANGLE_POWER_TOTAL PREVIOUS_VALUES DEMAND LOAD_PROFILE_CH_1 ALARM_SETTINGS_1 NRG_ENERGY_VALUE_CURR TARIFF_CALENDAR_CONFIG TARIFF_SPECIAL_DAYS_CONFIG IO_SETTING IO_PULSE_LENGTH_1...
  • Page 108 IO_PULSE_PORT_NBR_2 IO_PULSE_PORT_NBR_3 IO_PULSE_PORT_NBR_4 IO_PULSE_ENERGY_TYPE_1 IO_PULSE_ENERGY_TYPE_2 IO_PULSE_ENERGY_TYPE_3 SERIAL_NR TYPE_DESIGNATION FIRMWARE_VERSION TARIFF_INPUT_CONFIG TRAFO_CT_RATIO_NUMERATOR TRAFO_CT_RATIO_DENOMINATOR TRAFO_VT_RATIO_NUMERATOR TRAFO_VT_RATIO_DENOMINATOR CLOCK TARIFF_CALENDAR_CONFIG TARIFF_CALENDAR_CONFIG TARIFF_ACTIVE_DAY_TYPE TARIFF_ACTIVE_SEASON POWER_OUTAGE_TIME POWER_FAIL_COUNTER IO_PULSE_ENERGY_TYPE_4 IO_CURRENT_OUTPUT_STATE CLOCK_DST HDLC_SLAVE_BACKPLANE_1 PHASE_ANGLE_VOLTAGE_L1 PHASE_ANGLE_CURRENT_L1 CURRENT_QUADRANT_L1 PHASE_ANGLE_VOLTAGE_L2 PHASE_ANGLE_CURRENT_L2 CURRENT_QUADRANT_L2 PHASE_ANGLE_VOLTAGE_L3 PHASE_ANGLE_CURRENT_L3 CURRENT_QUADRANT_L3 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 109 JSON Communication phase_angle_voltage_l1-l2 phase_angle_voltage_l2-l3 CURRENT_QUADRANT_TOTAL FREQUENCY RSTREG_ACT_ENERGY_IMP RSTREG_ACT_ENERGY_EXP RSTREG_REACT_ENERGY_IMP RSTREG_REACT_ENERGY_EXP RSTREG_ACT_CNTR_IMP RSTREG_ACT_CNTR_EXP RSTREG_REACT_CNTR_IMP RSTREG_REACT_CNTR_EXP HARMONICS_VOLTAGE_L1 HARMONICS_VOLTAGE_L2 HARMONICS_VOLTAGE_L3 HARMONICS_VOLTAGE_L1_L2 HARMONICS_VOLTAGE_L2_L3 HARMONICS_VOLTAGE_L1_L3 HARMONICS_CURRENT_L1 HARMONICS_CURRENT_L2 HARMONICS_CURRENT_L3 HARMONICS_CURRENT_NEUTRAL TARIFF_ACTIVE TARIFF_SOURCE HARDWARE_VERSION_0 HARDWARE_VERSION_1 HARDWARE_VERSION_2 HARDWARE_VERSION_3 HARDWARE_VERSION_4 HARDWARE_VERSION_5 HARDWARE_VERSION_6 HARDWARE_VERSION_7 MBUS_CLIENT_0 PREVIOUS_VALUES DEMAND LOAD_PROFILE_CH_1 RSTREG_ACT_ENERGY_IMP RSTREG_ACT_ENERGY_EXP RSTREG_REACT_ENERGY_IMP RSTREG_REACT_ENERGY_EXP IO_INPUT_CUMULATION_1...
  • Page 110 To Read the parameter refer the index from 1 to 200. To Reset the parameter refer the index from 201 to 220. To configure the parameter refer the index from 221 to 256. Protected Yes (Authentication required) Request GET /meters/<serial>/associationobjects HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples meters/ABB_8/associationobjects • https://192.168.1.12/ 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 111 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "associationobjects": [ "role": "View Only", "serial": "ABB_1" 2CMC489001M0201 User Manual Revision: A...

  • Page 112: Get /Meters

    "des":"received invalid response from COSEM." 6.3.31 GET /meters A GET call to /meters returns list of meters registered with gateway. Protected Yes (Authentication required) Request GET /meters HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples meters • https://192.168.1.12/ 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 113 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "alias": "Gateway", "location": "ABB Gateway Zone", "serial": "ABBXXXXXXXXXXXXX", "locations": [ "location": "Level1", "serial": " ", "meters": [ "alias": "ABB_8", "serial": "ABB_8", "protocol": "3", "address": "17", "status": 1...
  • Page 114 Mac address status [Int] - Status of connectivity. Offline(-1), Registered(0), Online(1) • 500 Internal Server Error HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 115: Post /Meters/

    JSON Communication 6.3.32 POST /meters/<serial> A POST call to /meters/<serial> updates device alias name and location configu- ration. Protected Yes (Authentication required) Request POST /meters/ABB_8 HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 56 {"alias":"ABB_8", "location":"location1", "serial":"ABB_8"} Description • alias[String 21] - Gateway alias name •...

  • Page 116: Put /Meters

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.33 PUT /meters A PUT call to /meters registers a meter with gateway. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 117 JSON Communication Request PUT /meters HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 56 {"alias":"ABB_8", "location":"location2", "serial":"ABB_8"} Description • alias[String 21] - Gateway alias name • locati • on[String 51] - Gateway location name serial[String 17] - Gateway serial number • Examples •...

  • Page 118: Delete /Meters/

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.34 DELETE /meters/<serial> A DELETE call to /meters/ABB_8 deregisters a meter with gateway. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 119 JSON Communication Request DELETE /meters HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 56 {"alias":"ABB_8", "location":"location2", "serial":"ABB_8"} Description • alias[String 21] - Gateway alias name • location[String 51] - Gateway location name • serial[String 17] - Gateway serial number Example • https://192.168.1.12/meters/ABB_2 2CMC489001M0201...

  • Page 120: Get /Meters/Scanned

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.35 GET /meters/scanned A GET call to /meters returns list of scanned meters. Protected Yes (Authentication required) Request GET /meters/scanned HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Example • https://192.168.1.12/meters/scanned 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 121 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "scanresult": [ "token": 1337581086, "serial": "ABB_3", "protocol": "3", "address": "17" "scancomplete": 0 Description • scanresult [Array of Objects] - Array of scanned meter objects token [Int] - token for scan.

  • Page 122: Post /Meters/Scanned/

    JSON Communication 6.3.36 POST /meters/scanned/<token> A POST call to /meters/scanned/<token> triggers a new scan request if another one is not in progress. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 123 JSON Communication Request POST /meters/scanned/token HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 278 "zigbee": 3, "eqbus": { "start": 17, "end": 49 "mbus-wired": { "baudrate": 2400, "devices": [1, 2, 3] "mbus-ir": { "baudrate": 4800, "primary": {} "token": 1342526556 Description zigbee : Maximum of 32 devices can be specified •...
  • Page 124 9600, "primary": {} }, "token": 1342530975 } A sum of 32 devices out of all protocols can be scanned per request. Only one scan can be scheduled at any given time. Examples • https://192.168.1.12/meters/scanned/1342526556 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 125: Delete /Meters/Scanned

    JSON Communication 200 Success • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} • 400 Bad Request HTTP/1.1 400 Bad Request Server: embOS/IP Accept-Ranges: bytes Content-Length: 57 Content-Type: application/json "status":"error", "des":"JSON parse error." • 500 Internal Server Error HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes...
  • Page 126 Maximum meters specified in payload should not exceed 15. Examples • https://192.168.1.12/meters/scanned 200 Success Response • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "deletescanned": [ {"serial": "ABB_4","status": 1}, {"serial": "ABB_2","status": -1} 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 127: Get /Permittedmeters

    JSON Communication Description deletescanned [Array of objects] - Array of scanned meter objects • serial[String 17] : Serial Number of scanned meter. • status[Int32] : Indicates the status of meter deleted. 1 : meter deleted successfully from scan list -1 : meter is not found in the scan list •...

  • Page 128: Put /Permittedmeters

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.39 PUT /permittedmeters A PUT call to /permittedmeters adds a new meter to list. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 129 JSON Communication Request PUT /permittedmeters HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 23 {"meters":["ABBXXXXXXXXXXXXX1", "ABBXXXXXXXXXXXXX2"]} Description Meters is an array of serial numbers of zigbee devices. • Examples • https://192.168.1.12/permittedmeters 2CMC489001M0201 User Manual Revision: A...

  • Page 130: Delete /Permittedmeters

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.40 DELETE /permittedmeters A DELETE call to /permittedmeters deletes meter from list. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 131 JSON Communication Request DELETE /permittedmeters HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 23 "meters":[ "ABBXXXXXXXXXXXXX1", "ABBXXXXXXXXXXXXX2"] Description meters [array of serial numbers (string 17)] • Examples • https://192.168.1.12/permittedmeters 2CMC489001M0201 User Manual Revision: A...

  • Page 132: Get /Meters//Datetime

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.41 GET /meters/<serial>/datetime A GET call to /meters/<serial>/datetime returns datetime settings of meter. Protected Yes (Authentication required) Request GET /meters/<serial>/datetime HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/datetime 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 133 JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "datetime": "2012-08-05T01: 11: 31", "dayofweek": 7, "dst": 1, "dstenable": true, "dstend": { "month": 10, "day": 1, "week": 1, "hour": 1 "dststart": { "month": 6, "day": 1, "week": 1, "hour": 2...

  • Page 134: Post /Meters//Datetime

    Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.42 POST /meters/<serial>/datetime A POST call to /meters/<serial>/datetime updates date time of meter and DST Configuration. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 135 JSON Communication Request POST /meters/ABB_3/datetime HTTP/1.1 Host: 192.168.1.12 Content-Length: 171 Authorization: Basic XXXXXXXXXXXXXXX= "datetime": "2012-08-05T01:11:31", "dstenable": true, "dststart": {"month":6,"day":1,"week":1,"hour":2}, "dstend": {"month":10,"day":1,"week":1,"hour":1} Description It is possible to do in the following ways also: POST only datetime. • POST datetime and disable the DST configuration by setting •...

  • Page 136: Get /Meters//Info

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.43 GET /meters/<serial>/info A GET call to /meters/<serial>/info returns general information of meter. Protected Yes (Authentication required) Request GET /meters/<serial>/info HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/info 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 137 JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "manufacturing": { "serial": "1231", "label": "A44 514-100", "firmwareversion": "A0.0.0.0" "ratio": { "ctdenum": "1", "ctnum": "1", "vtdenum": "1", "vtnum": "1" "conversionfactor": { "co2": [ 1.123, "kg/kWh"...

  • Page 138: Get /Meters//Energy/Conversionfactor

    "des":"received invalid response from COSEM." 6.3.44 GET /meters/<serial>/energy/conversionfactor A GET call to /meters/<serial>/conversionfactor returns CO2 and Currency con- version factor. Protected Yes (Authentication required) Request GET /meters/<serial>/energy/conversionfactor HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/conversionfactor 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 139: Post /Meters//Energy/Conversionfactor

    JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "conversionfactor": { "co2": [ 1.123, "kg/kWh" "currency": [ 100.789, "curr/kWh" Description co2 [Array] - co2 conversion factor and unit. • currency [Array] - currency conversion factor and unit. •...
  • Page 140 • currency [Double/Int] - currency conversion factor value should be less than 999999.000. Note • User can update either co2 or currency or both. • Here, values are specified as per the following units, co2=>"kg/kWh", currency =>"curr/kWh". Examples • https://192.168.1.12/meters/ABB_8/conversionfactor 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 141: Get /Meters//Hardwareversion

    JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} • 500 Internal Server Error HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.46 GET /meters/<serial>/hardwareversion A GET call to /meters/<serial>/hardwareversion returns version numbers of var- ious components of meter (main+I/O+RS-485).

  • Page 142: Get /Meters//Mbusinfo

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.47 GET /meters/<serial>/mbusinfo A GET call to /meters/<serial>/mbusinfo returns M-Bus meter related informa- tion. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 143 JSON Communication Request GET /meters/<serial>/mbusinfo HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/mbusinfo 200 OK Response • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "manufacturer": "ABB", "devicetype": 2, "addressingmode": 1, "version": 32, "id": 1234 2CMC489001M0201 User Manual Revision: A...
  • Page 144 JSON Communication Description • manufacturer [string 3] : "ABB", • medium [int] Other: 00 Oil: 01 Electricity: 02 Gas: 03 Heat: 04 Steam: 05 Warm Water (30°C-90°C): 06 Water: 07 Heat Cost Allocator: 08 Compressed Air: 09 Cooling load meter (Volume measured at return temperature: outlet): 0A...

  • Page 145: Post /Meters//Transformersettings

    JSON Communication 6.3.48 POST /meters/<serial>/transformersettings A POST call to /meters/<serial>/transformersettings updates transformer settings of meter. Protected Yes (Authentication required) Request POST /meters/ABB_3/transformersettings HTTP/1.1 Host: 192.168.1.12 Content-Length: 54 Authorization: Basic XXXXXXXXXXXXXXX= {"ctnum":"1","ctdenum":"1","vtnum":"1","vtde- num":"1"} Description • ctnum [Int] - CT numerator • ctdenum [Int] - CT de-nominator •...

  • Page 146: Get /Meters//Status

    Protected Yes (Authentication required) Request GET /meters/<serial>/status HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Example • https://192.168.1.12/meters/ABB_8/status Response • 200 OK HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 { "serial":1238, "label": "A44 512-100" 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 147: Get /Meters//Statusflags

    5 - Platinum 1 - Class 1.0 2 - RS 485 Port 1 - IEC approved + MID approved and verified 0 - ABB standard version 0 - ABB standard version 500 Internal Server Error • HTTP/1.1 500 Internal Server Error...
  • Page 148 • https://192.168.1.12/meters/ABB_8/statusflags 200 OK Response • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "errors": [ "ABB Specific Str 2", "ABB Specific Str 3" "warnings": [ "NEG_POW Element2 " "informationflags": [ "Alarm6 Active", "Alarm7 Active" 2CMC489001M0201 G13 Revision: A...
  • Page 149 • errors [Array of String] - Object of active errors. Array may include: "Audit Log" "Program Crc" "Persistent Storage" "Rtc Circuit" "Acref" "Temp Sensor" "ABB Specific Str 1" "ABB Specific Str 2" "ABB Specific Str 3" "ABB Specific Str 4" "ABB Specific Str 5" "ABB Specific Str 6" "ABB Specific Str 7"...

  • Page 150: Get /Meters//Events//

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.51 GET /meters/<serial>/events/<datetime>/<count> A GET call to /meters/<serial>/events/<datetime>/<count> returns events logged in requested meter. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 151 JSON Communication Request GET /meters/<serial>/events/<datetime>/<count> HTTP/ Authorization: Basic XXXXXXXXXXXXXXX= Parameters serial [String 17] - Serial number of the meter. • • datetime [DateTime] - Events until a date time. eg. 2012-05-16T13:54:00. count [Int, Optional] - Default value 100. Number of events •...
  • Page 152 "duration": 0, "category": 2, "logid": 1003 "quality": [ "datetime": "2011-12-19T10:12:00", "duration": 0, "category": 2, "logid": 1001 "datetime": "2011-12-18T10:12:00", "duration": 0, "category": 2, "logid": 1003 "event": [ "datetime": "2011-12-19T10:12:00", "duration": 0, "category": 2, "logid": 1001 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 153 JSON Communication "datetime": "2011-12-18T10:12:00", "duration": 0, "category": 2, "logid": 1003 2CMC489001M0201 User Manual Revision: A...
  • Page 154 • logid[Int] : Id of log structure as per following table Error AUDIT_LOG_ERROR Audit log error PROGRAM_CRC_ERROR Program CRC error PERSISTENT_STORAGE_ERROR Persistent memory storage error ABB_SPECIFIC_STR_1_ERROR ABB sepcific STR 1 error ABB_SPECIFIC_STR_2_ERROR ABB sepcific STR 2 error ABB_SPECIFIC_STR_3_ERROR ABB sepcific STR 3 error ABB_SPECIFIC_STR_4_ERROR ABB sepcific STR 4 error...
  • Page 155 JSON Communication Warning 1000 U1_MISSING_WARNING Phase 1 is missing warning 1001 U2_MISSING_WARNING Phase 2 is missing warning 1002 U3_MISSING_WARNING Phase 3 is missing warning 1003 PHASE_CONN_NEUTRAL_WARNING Neutral warning 1004 NEG_POW_ELEMENT_1_WARNING Negative power of Element 1 warning 1005 NEG_POW_ELEMENT_2_WARNING Negative power of Element 2 warning 1006 NEG_POW_ELEMENT_3_WARNING Negative...
  • Page 156 Powerfail Information • datetime[String]: timestamp when event occurred • duration[Int]: duration of an event persists in seconds 500 Internal Server Error • HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 157: Get /Meters//Alarms/Configuration

    JSON Communication "status":"error", "des":"received invalid response from COSEM." 6.3.52 GET /meters/<serial>/alarms/configuration A GET call to /meters/<serial>/alarms/configuration returns meter alarm config- uration. Protected Yes (Authentication required) Request GET /users HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/alarms/configuration 2CMC489001M0201 User Manual Revision: A...
  • Page 158 "log": 4000, "output": 5000 "id": 2, "quantity": 70, "onthreshold": -1, "offthreshold": -1, "ondelay": 2, "offdelay": 0, "log": 5, "output": 10 "id": 20 .."id": 25, "quantity": 72, "onthreshold": 0, "offthreshold": 0, "ondelay": 0, "offdelay": 0, 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 159 JSON Communication "log": 1000, "output": 1000 Description id[Int]: Alarm number(1 to 25) • quantity[Int]: quantity index as per parametermapping • onthreshold[Int]: threshold level • offthreshold[Int]: threshold level • ondelay[Int]: on delay in secons • offdelay[Int]: off delay in seconds • log[Bool]: boolean says, log is true or false •...

  • Page 160: Post /Meters//Alarms/Configuration

    • onthreshold[Int]: threshold level • offthreshold[Int]: threshold level • ondelay[Int]: on delay in secons • offdelay[Int]: off delay in seconds • log[Bool]: boolean says, log is true or false • output[Int]: outport number (1 to 4) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 161 JSON Communication Note To make a channel "inactive", the request should skip all parameters except id as shown below: "alarmconfig": "id": 25, Examples • https://192.168.1.12/meters/ABB_8/alarms/configuration • 200 Success Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} 400 Bad Request •...

  • Page 162: Get /Meters//Energy/

    Parameters type - 'active', 'reactive', 'apparent' • Note Not all meter types support reactive and apparent measurements. Please refer to product manual for list of supported parameters. Examples • https://192.168.1.12/meters/ABB_8/energy/active • https://192.168.1.12/meters/ABB_8/energy/reactive • https://192.168.1.12/meters/ABB_8/energy/apparent 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 163 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "importenergy": { "l1": [ "1758307.29", "kWh" "l2": [ "12718357.27", "kWh" "l3": [ "77587522.36", "kWh" "t1": [ "0.16", "kWh" "t2": [ "0.00", "kWh" "t3": [ "0.00", "kWh"...
  • Page 164 "77583.27", "kWh" "t1": [ "2.36", "kWh" "t2": [ "0.00", "kWh" "t3": [ "0.00", "kWh" "t4": [ "2.36", "kWh" "total": [ "12718.36", "kWh" "netenergy": { "l1": [ "75824875.12", "kWh" "l2": [ "-12443117.40", "kWh" "l3": [ 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 165: Get /Meters//Energy//

    JSON Communication "-77580916.94", "kWh" "total": [ "-10959959.88", "kWh" Description exportenergy [Object] - Object of export energy. • lx [Array] - line export energy and unit [x can be 1 to 3]. tx [Array] - line export tariff energy and unit [x can be 1 to 4]. total [Array] - total export energy and unit.
  • Page 166 Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "importenergy": { "total": [ "0.00", "KG" 500 Internal Server Error • HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 167: Get /Meters//Energy/Resettable

    JSON Communication Description • importenergy[object] - total import energy total [Array] -total import energy and unit. JSON response is the same for active/co2 and active/currency energy except unit. 6.3.56 GET /meters/<serial>/energy/resettable A GET call to /meters/<serial>/energy/resettable returns resettable energy values of requested meter.
  • Page 168 "status":"error", "des":"received invalid response from COSEM." Description resettable energy: combination of active import and export energies activeimport[array] - value of active import and unit • • activeexport[array] - value of active export and unit 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 169: Post /Meters//Energy/Resettable

    JSON Communication 6.3.57 POST /meters/<serial>/energy/resettable A POST call to /meters/<serial>/energy/resettable clears resettable energy regis- ter values of requested meter. Reset counter is incremented each time resettable energy registers are reset. User can reset any one or all of following registers 1.

  • Page 170: Get /Meters//Energy/Resetcounter

    Reset counter is incremented each time these registers are reset. It holds number of times the resettable registers are reset. Yes (Authentication required) Protected Request GET /meters/<serial>/energy/resetcounter HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/energy/resetcounter 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 171: Get /Meters//Powers

    JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "resetcounter": { "activeexport": "0.00", "activeimport": "0.00" • 500 Internal Server Error HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM."...
  • Page 172 "l3" : [ "1000003", "W" ], "total" : [ "100000", "W" ] "apparent" : { "l1" : [ "1100001", "W" ], "l2" : [ "1100002", "W" ], "l3" : [ "1100003", "W" ], "total" : [ "1100004", "W" ] 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 173: Get /Meters//Instrument

    JSON Communication Description active [Object] - Object of active power. • lx [Array] - Active line power value and unit [x can be 1 to 3]. total [Array] - Total active power and unit. reactive [Object] - Object of reactive energy. •...
  • Page 174 Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "l1":{ "current":["0.00","A"], "currentquadrant":["0",""], "phaseanglecurrent":["0.0","deg"], "phaseanglepower":["0.00","deg"], "phaseanglevoltage":["0.0","deg"], "powerfactor":["0.000",""], "voltage":["227.1","V"] "l2":{ "current":["0.00","A"], "currentquadrant":["0",""], "phaseanglecurrent":["0.0","deg"], "phaseanglepower":["0.00","deg"], "phaseanglevoltage":["5.5","deg"], "powerfactor":["0.000",""], "voltage":["56.8","V"] "l3":{ "current":["0.00","A"], "currentquadrant":["0",""], "phaseanglecurrent":["0.0","deg"], "phaseanglepower":["0.00","deg"], "phaseanglevoltage":["-164.7","deg"], "powerfactor":["0.000",""], "voltage":["42.9","V"] "l1-l2":{ "voltage":["182.8","V"], "l2-l3":{ "voltage":["81.80","V"], "l1-l3":{ 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 175 JSON Communication "voltage":["251.920","V"], "neutral":{ "current":["0.00","A"] "total":{ "currentquadrant":["0",""], "phaseanglepower":["0.00","deg"], "powerfactor":["0.000",""] "frequency":{ "frequency":["49.78","Hz"] 2CMC489001M0201 User Manual Revision: A...

  • Page 176: Get /Meters//Harmonics/Voltage

    Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.61 GET /meters/<serial>/harmonics/voltage A GET call to /meters/<serial>/harmonics/voltage returns voltage harmonic val- ues of requested meter. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 177 JSON Communication Request GET /meters/<serial>/harmonics/voltage HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/harmonics/voltage 2CMC489001M0201 User Manual Revision: A...
  • Page 178 "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0" "thd": "0" "l2": { "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 179 JSON Communication "0", "0", "0", "0", "0" "thd": "0" "l3": { "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0" "thd": "0" "l1-l2": { "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0",...
  • Page 180 "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0" "thd": "0" "l1-l3": { "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 181: Get /Meters//Harmonics/Current

    JSON Communication "0" "thd": "0" Description There can be a max of 16 harmonics in current version of meters. Note Values are represented in %. • 500 Internal Server Error HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM."...
  • Page 182 "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0" "thd": "0" "l2": { "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 183 JSON Communication "0", "0", "0", "0", "0" "thd": "0" "l3": { "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0" "thd": "0" "neutral": { "harmonics": [ "0", "0", "0", "0", "0", "0", "0", "0",...

  • Page 184: Get /Meters//Io

    Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.63 GET /meters/<serial>/io A GET call to /meters/<serial>/io returns io status. Protected Yes (Authentication required) Request GET /meters/<serial>/io HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Example • https://192.168.1.12/meters/ABB_8/io 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 185 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "iostatus": [ "currentstate": 0 "currentstate": 0, "storedstate": 0, "counter": 292939 "currentstate": 1, "storedstate": 1, "counter": 48448 "currentstate": 0 2CMC489001M0201 User Manual Revision: A...

  • Page 186: Get /Meters//Io/Configuration

    "status":"error", "des":"received invalid response from COSEM." 6.3.64 GET /meters/<serial>/io/configuration A GET call to /meters/<serial>/io/configuration returns configuration of Input and Outputs. Protected Yes (Authentication required) Request GET /meters/<serial>/io/configuration HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/io/configuration 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 187 JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0s "ioconfig": [ "pulse_out", "always_on", "alarm_out", "input" Description Possible channels for an IO port are: input • • communiation_out • alarm_out • pulse_out • tariff_out •...

  • Page 188: Get /Meters//Io/Pulse

    JSON Communication 6.3.65 GET /meters/<serial>/io/pulse A GET call to /meters/<serial>/io/pulse returns configuration of pulse Input and Outputs. Protected Yes (Authentication required) Request GET /meters/<serial>/io/pulse HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/io/pulse 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 189 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "pulse": [ "length": 100, "frequency": 10000, "energytype": "active_import", "port": 0 "length": 100, "frequency": 10000, "energytype": "active_export", "port": 1 "length": 100, "frequency": 10000, "energytype": "active_import", "port": 255 "length": 100, "frequency": 10000,...

  • Page 190: Post /Meters//Io

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.66 POST /meters/<serial>/io A POST call to /meters/<serial>/io updates Input Output state. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 191 JSON Communication Request POST /meters/<serial>/io HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 437 "iostatus": [ "port": 1, "currentstate": 0 "port": 2, "reset": [ "storedstate", "counter" "port": 3, "reset": [ "storedstate", "counter" "port": 4, "currentstate": 0 Description 2CMC489001M0201 User Manual Revision: A...
  • Page 192 Port4 as output, and it's state is set to ON state { "iostatus": [ { "port": 3, "reset": [ "storedstate", "counter" ] }, { "port": 4, "currentstate": 1 } ] } Examples • https://192.168.1.12/meters/ABB_8/io 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 193: Post /Meters//Io/Configuration

    JSON Communication • 200 Success Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} 500 Internal Server Error • HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.67 POST /meters/<serial>/io/configuration A POST call to /meters/<serial>/io/configuration updates Input Output configu- ration.
  • Page 194 • Alarm Out = 2 • Pulse Out = 3 • Tariff Out = 4 • Always On = 5 • Always Off = 6 • Dont Change = 0xff • Examples • https://192.168.1.12/meters/ABB_8/io/configuration 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 195: Post /Meters//Io/Pulse

    JSON Communication • 200 Success Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status":"success"} 500 Internal Server Error • HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.68 POST /meters/<serial>/io/pulse A POST call to /meters/<serial>/io/pulse updates pulse configuration.
  • Page 196 "port": 2, "length": 100, "frequency": 10000, "energytype": 2 "id": 2, "port": 1, "length": 100, "frequency": 10000, "energytype": 2 "id": 3, "port": 4, "length": 100, "frequency": 10000, "energytype": 0 "id": 4, "port": 255, "length": 100, 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 197 JSON Communication "frequency": 10000, "energytype": 3 Description pulse[Array of Objects] • • length[int] - Pulse length in milliseconds • frequency[int] - Pulse frequency in impulses per second • energytype[string] - Pulse energy type Energy types are: active_import = 0 active_export = 1 reactive_import = 2 reactive_export = 3 turned_off = 4...

  • Page 198: Get /Meters//Previousvalues//

    Authorization: Basic XXXXXXXXXXXXXXX= Description fromdate • datetime in YYYY:MM:DDTHH:MM:SS form, data is requested from this time todate • datetime in YYYY:MM:DDTHH:MM:SS form, data is requested till this time count • count up to 100 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 199 JSON Communication Examples from date and count https://192.168.1.12/meters/ABB_8/previousvalues/2012-07- 01T01:00:00/100 from date and to date • https://192.168.1.12/meters/ABB_8/previousvalues/2012-07- 01T01:00:00/2012-07-07T01:00:00 default case - no date and count given. All values in meter will be • returned. https://192.168.1.12/meters/ABB_8/previousvalues Response • 200 OK HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked...

  • Page 200: Get /Meters//Previousvalues/Configuration

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.70 GET /meters/<serial>/previousvalues/configuration A GET call to /meters/<serial>/previousvalues/configuration returns previousval- ues configuration. Protected Yes (Authentication required) Request GET /meters/<serial>/previousvalues/configuration HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/previousvalues/configuration 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 201: Post /Meters//Previousvalues/Configuration

    JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "interval":"weekly", "weekday" : 1, "pvconfig":[1,2,3,4,5,6,7,8,9,10,11,12,53,54] Description • interval Interval can be daily, weekly or monthly • weekday Week day is applicable if period is week. And values are 1 - Monday to 7 - Sunday •...
  • Page 202 • interval Interval can be "daily", "weekly" or "monthly" • weekday Weekday is optional and applicable in case if interval is "weekly" • pvconfig Array of quantity ids as per /storablequantities Examples • https://192.168.1.12/meters/ABB_8/previousvalues/configuration 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 203: Delete /Meters//Previousvalues

    JSON Communication • 200 OK Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "status":"success" • 502 Internal Server Error HTTP/1.1 502 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.72 DELETE /meters/<serial>/previousvalues A DELETE call to /meters/<serial>/previousvalues clears all Previous Values.

  • Page 204: Get /Meters//Loadprofiles///

    "des":"received invalid response from COSEM." 6.3.73 GET /meters/<serial>/loadprofiles/<channel>/<fromdate>/ <count|todate> A GET call to /meters/<serial>/loadprofiles/<channel>/<fromdate>/<count/to- date> returns lp values per channel for the given combinations: • date & count • between from date & to date 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 205 JSON Communication • fromdate : datetime in yyyy:mm:ddThh:mm:ss form, data is requested Request query from this time parameters • count:count can be up to 40000 depending on configuration and meter type. • todate : datetime in yyyy:mm:ddThh:mm:ss form, data is requested till this time Protected Yes (Authentication required)

  • Page 206: Get /Meters//Loadprofiles/Configuration

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.74 GET /meters/<serial>/loadprofiles/configuration A GET call to /meters/<serial>/loadprofiles/configuration returns lp configura- tion. Protected Yes (Authentication required) Request GET /meters/<serial>/loadprofiles/configuration HTTP/ Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/loadprofiles/configuration 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 207 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "lpconfig": [ 15000 120, 7000 21600, 2000 180, 5000 3600, 1000 600, 2000 450, 2CMC489001M0201 User Manual Revision: A...

  • Page 208: Post /Meters//Loadprofiles/Configuration

    "des":"received invalid response from COSEM." 6.3.75 POST /meters/<serial>/loadprofiles/configuration A POST call to /meters/<serial>/loadprofiles/configuration configures lp config- uration for all 8 channels. Note Configuration erases all entries stored so far and clears current configuration. Protected Yes (Authentication required) 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 209 JSON Communication Request POST /meters/<serial>/loadprofiles/configuration HTTP/1.1 2CMC489001M0201 User Manual Revision: A...
  • Page 210 JSON Communication Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 205 "lpconfig": [ 15000 120, 7000 21600, 2000 180, 5000 3600, 1000 600, 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 211 JSON Communication 2000 450, 3000 86400, 5000 Description lpconfig [Array of lp objects[interval,quantity,Item count]] • interval[Int]: interval in seconds. Possible values are 1m, 2m , 3m, 5m , 10m , 15m , 30m, 1h, 2h , 3h , 6h , 12h, 1d.

  • Page 212: Delete /Meters//Loadprofiles

    A DELETE call to /meters/<serial>/loadprofiles clears LoadProfile values. Yes (Authentication required) Protected Request DELETE /meters/<serial>/loadprofiles/<channel> HTTP/ Authorization: Basic XXXXXXXXXXXXXXX= Description Channel is optional. When omitted it erases all channels. Examples • https://192.168.1.12/meters/ABB_8/loadprofiles/1 • https://192.168.1.12/meters/ABB_8/loadprofiles 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 213: Get /Meters//Demand/

    JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "status":"success" 403 Forbidden • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 {"status": "error","des": "received READ_WRITE_DENIED response from COSEM."} 502 Internal Server Error •...
  • Page 214 YYYY:MM:DDTHH:MM:SS form, data is • requested till this time Examples from date and count • https://192.168.1.12/meters/ABB_8/demand/2012-07-01T01:00:00/100 from date and to date • https://192.168.1.12/meters/ABB_8/demand/2012-07-01T01:00:00/2012- 07-07T01:00:00 default case - no date and count given • https://192.168.1.12/meters/ABB_8/demand 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 215 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "mapping": [ "active_import_total", "W" "active_import_total", "W" "active_import_total", "W" "items": [ "0", "4294967295", "2012-06-17T02:40:00", "1" "0", "4294967295", "2012-06-17T02:40:00", "2" "0", "4294967295", "2012-06-17T02:40:00", "3" 2CMC489001M0201 User Manual Revision: A...
  • Page 216 Valid values for status- it is combination of bit positions: BIT0: 0 - Not available, 1 - Snapshot already exists BIT1: 0 - OK, 1 - Data Error BIT2: 0 - OK, 1 - Power off 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 217: Get /Meters//Demand/Configuration

    JSON Communication Following explanation elaborates the status handling: If bit1 is set it is data error and no need to parse further Else follow next step If bit0 is set follow next step Else conclude as data not available If bit2 is set it is a power off scenario Else it is good and OK status value •...
  • Page 218 • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "dmc": [ [ 1, 1], [ 1, 2] up to 50 channels "interval": [ 900, 60 ] "period": "weekly", "weekday" : 2 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 219 JSON Communication Description • This is array of configuration of each channel. Array sequence is formatted as [QuantityId, Dem and Code]. QuantityID is ID from storable quantities And Demand code is encoded with billing period, demand type and level as below: Billing Demand Level Code...

  • Page 220: Post /Meters/ /Demand/ Configuration

    6.3.79 POST /meters/ <serial>/demand/ configuration A POST call to /meters/<serial>/demand/configuration configures demand con- figuration for all 50 channels. Note Configuration erases all entries stored so far and clears current configura- tion. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 221 JSON Communication Request POST /meters/<serial>/demand/configuration HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Content-Type:application/json Content-Length: 119 "dmc": [ [ 1, 1], [ 1, 2] up to 50 channels "interval": [ 900, 60 ] "period": "weekly", "weekday" : 2 Description • This is array of configuration of each channel. Array sequence is formatted as [QuantityId, Dem and Code].

  • Page 222: Delete /Meters//Demand

    HTTP/1.1 502 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.80 DELETE /meters/<serial>/demand A DELETE call to /meters/<serial>/demand clears all Demand values. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 223 JSON Communication Request DELETE /meters/<serial>/demand HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/demand 200 OK Response • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "status":"success" 403 Forbidden • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "status": "error", "des": "received READ_WRITE_DENIED response from COSEM."...

  • Page 224: Get /Meters/ /Tariff

    • daytype [Int] - Current day's DayId [Refer dayid from [GET]/meters/ <serial>/dayprofile]. • season [Int] - Current day's Season [Refer season from [GET]/meters/ <serial>/seasonprofile]. • tariff [Int] - value between 1 to 4. tariffsource [Int] - [0-Clock, 1-Communication, 2-Input]. • 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 225 JSON Communication Note Daytype and Season are available only if source is set to Clock. 200 OK • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "tariff":1, "source":2, "inputconfig":[1,2,3,4] Description • tariff [Int] - value between 1 to 4. •...

  • Page 226: Post /Meters /Tariff

    Description tariff [Int]: 1 to 4. Tariffsource should be in Communication mode before setting the tariff. Request POST /meters/ABB_3/tariff HTTP/1.1 Host: 192.168.1.12 Content-Length: 30 Authorization: Basic XXXXXXXXXXXXXXX= "source": 2, "inputconfig": [1,2,3,4] Examples • https://192.168.1.12/meters/ABB_8/tariff 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 227 JSON Communication Description source [Int] - [0-Clock, 1-Communication, 2-Input]. inputconfig [Int] - length of array is equal to number of tariffs. Example When number of tariffs are 4 array would be [1,2,3,4]. Description of each ele- ment of array is described below: Input 4 Input 3 Note...

  • Page 228: Get /Meters//Tariff/Dayprofiles

    JSON Communication 6.3.83 GET /meters/<serial>/tariff/dayprofiles A GET call to /meters/<serial>/tariff/dayprofiles returns dayprofiles configura- tion Protected Yes (Authentication required) Request GET /meters/<serial>/tariff/dayprofiles HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/tariff/dayprofiles 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 229 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "dayprofiles": [ "actions": [ "00:00" "12:00" "profile": 0 "actions": [ "12:00" "15:00" "profile": 1 "actions": [ "02:00" 2CMC489001M0201 User Manual Revision: A...
  • Page 230 JSON Communication "profile": 2 "actions": [ "03:00" "profile": 3 "actions": [ "04:00" "profile": 4 "actions": [ "05:00" "profile": 5 "actions": [ "06:00" "profile": 6 "actions": [ "07:00" 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 231 JSON Communication "profile": 7 "actions": [ "08:00" "profile": 8 "actions": [ "09:00" "profile": 9 2CMC489001M0201 User Manual Revision: A...

  • Page 232: Post /Meters//Tariff/Dayprofiles

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.84 POST /meters/<serial>/tariff/dayprofiles A POST call to /meters/<serial>/tariff/dayprofiles updates dayprofileid, profile- starttime, action. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 233 JSON Communication Request POST /meters/ABB_3/tariff/dayprofiles HTTP/1.1 Host: 192.168.1.12 Content-Length: 51 Authorization: Basic XXXXXXXXXXXXXXX= "actions":[[1,"12:00"],[2,"15:00"]],"profile":1 Parameters profile [Int] - Dayprofileid[1-16, maximum of16 day profiles can be configured]. • actions [actionId, starttime]: actionId [Int] - Which action has to perform when a switchpoint is activated.

  • Page 234: Get /Meters//Tariff/Weekprofiles

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.85 GET /meters/<serial>/tariff/weekprofiles A GET call to /meters/<serial>/tariff/weekprofiles returns weekprofiles configu- ration. Yes (Authentication required) Protected Request GET /meters/<serial>/tariff/weekprofiles HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/tariff/weekprofiles 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 235 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "weekprofiles": [ "dayid": [ "profile": "Week1" "dayid": [ "profile": "Week2" "dayid": [ 2CMC489001M0201 User Manual Revision: A...

  • Page 236: Post /Meters /Tariff /Weekprofiles

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.86 POST /meters <serial> /tariff /weekprofiles A POST call to /meters/<serial>/tariff/weekprofiles updates weekprofiles config- uration. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 237 JSON Communication Request POST /meters/ABB_3/tariff/weekprofiles HTTP/1.1 Host: 192.168.1.12 Content-Length: 207 Authorization: Basic XXXXXXXXXXXXXXX= "weekprofiles":[ {"profile":"Week1","dayid":[1,4,2,5,3,6,1]}, {"profile":"Week2","dayid":[1,2,3,7,5,6,7]}, {"profile":"Week3","dayid":[7,6,5,4,3,2,1]}, {"profile":"Week4","dayid":[3,4,7,8,11,12,14]}] Parameters profile [string(30)] - WeekProfileName[maximum of 4 week • profiles can be configured]. dayid [Array of Int value] - Id of dayprofile to execute. •...

  • Page 238: Get /Meters//Tariff/Seasonprofiles

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.87 GET /meters/<serial>/tariff/seasonprofiles A GET call to /meters/<serial>/tariff/seasons returns season profiles configura- tion. Protected Yes (Authentication required) Request GET /meters/<serial>/tariff/seasons HTTP/1.1 Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/tariff/seasons 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 239 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "seasonprofiles": [ "day": 254, "month": 10, "profile": "Winter", "weekprofile": "Week1" "day": 1, "month": 5, "profile": "Summer", "weekprofile": "Week2" "day": 1, "month": 9, "profile": "Autumn", "weekprofile": "Week3"...

  • Page 240: Post /Meters//Tariff/Seasonprofiles

    HTTP/1.1 500 Internal Server Error Server: embOS/IP Accept-Ranges: bytes Content-Length: 64 Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.88 POST /meters/<serial>/tariff/seasonprofiles A POST call to /meters/<serial>/tariff/seasonprofiles updates seasonprofiles con- figuration Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 241 JSON Communication Request POST /meters/ABB_3/tariff/seasonprofiles HTTP/1.1 Host: 192.168.1.12 Content-Length: 296 Authorization: Basic XXXXXXXXXXXXXXX= "seasonprofiles":[ {"day":254,"month":10,"profile":"Winter","week- profile":"Week1"}, {"day":1,"month":5,"profile":"Summer","weekpro- file":"Week2"}, {"day":1,"month":9,"profile":"Autumn","weekpro- file":"Week3"}] Description day [Int] - Season startdayOfMonth. • • month [Int] - Season startmonth. • profile [String(30)] - Season name. • startime [String] - Season starttime [Month:Day]. •...

  • Page 242: Get /Meters//Tariff/Specialdayprofiles

    Content-Type: application/json "status":"error", "des":"received invalid response from COSEM." 6.3.89 GET /meters/<serial>/tariff/specialdayprofiles A GET call to /meters/<serial>/tariff/specialdayprofiles returns specialdaypro- files configuration. Yes (Authentication required) Protected Request GET /meters/<serial>/tariff/specialdayprofiles HTTP/ Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/meters/ABB_8/tariff/specialdayprofiles 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 243 JSON Communication 200 OK • Response HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 "specialdayprofiles": [ "date": { "day": 254, "month": 11, "week": 255, "year": 65535 "dayprofile": 1, "profile": 1 "date": { "day": 1, "month": 255, "week": 255, "year": 2011 "dayprofile": 2, "profile": 2...

  • Page 244: Post /Meters/ /Tariff/Specialdayprofiles

    If profileid already exists but it doesn't match with specified date, then it adds a new entry and profileid will be updated sequentially. Maximum of 50 special day profiles can be configured. Yes (Authentication required) Protected 2CMC489001M0201 G13 Revision: A User Manual...
  • Page 245 JSON Communication Request POST /meters/ABB_3/tariff/specialdayprofiles HTTP/1.1 Host: 192.168.1.12 Content-Length: 88 Authorization: Basic XXXXXXXXXXXXXXX= "profile":1,"dayprofile":2, "date":{"year":1989,"month":11,"week":4,"day":254} Description profile [Int] - SpecialDayProfileId. • Date [Object] - SpecialDay Date. • dayprofileid - day profile id to execute. [Refer DayProfileId from • metersgetdayprofile]. Examples •...

  • Page 246: Get /Lasterror/

    Yes (Authentication required) Protected Request GET /lasterror/&lt;id> Authorization: Basic XXXXXXXXXXXXXXX= Examples • https://192.168.1.12/lasterror/23 200 Successful Response • HTTP/1.1 200 OK Content-Type: application/json Server: embOS/IP Transfer-Encoding: chunked Link:/lasterror/0 { "des" : "detailed description" } 2CMC489001M0201 G13 Revision: A User Manual...

  • Page 247: Annexure1

    JSON Communication 6.3.92 Annexure1 This Annexure describes the details of each parameter of meter label. Meter Label Meter label is in the form of Format XYZ ABC-DEF where • [X] stands for type of Enclosure: A : Enclosure -7 DIN Advanced B : Enclosure -4 DIN,2 DIN Advanced,Basic High,Basic Low C : Enclosure -3 DIN,1 DIN competitive D : Enclosure -2 DIN DC...
  • Page 248 • [E] stands for version class: 0 : ABB standard version 1 : Industrial version 2 : Rail application version • [F] stands for class variation of ABB/BHM versions: 0 : ABB standard version 1 : BHM version 1 2 : BHM version 2...
  • Page 249 JSON Communication 2CMC489001M0201 User Manual Revision: A...

Table of Contents