ABB G13 Page 223 User Manual Download

Page: 223 / 249

JSON Communication

G13

219

2CMC489001M0201



User Manual

Revision: A

Request

DELETE /meters/<serial>/demand HTTP/1.1

Authorization: Basic XXXXXXXXXXXXXXX=

Examples

• https://192.168.1.12/meters/ABB_8/demand

Response

•

200 OK

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

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."

}

Summary of Contents for G13

Page 1: ...G13 User Manual ...

Page 2: ......

Page 3: ...G13 User Manual Document ID 2CMC489001M0201 Revision A 2013 04 25 ...

Page 4: ...ment Copyrights This document and parts thereof must not be reproduced or copied without written permission from ABB AB and the contents thereof must not be imparted to a third party nor used for any unauthorized purpose The software or hardware described in this document is furnished under a license and may be used copied or disclosed only in accordance with the terms of such license Copyright 20...

Page 5: ...on 36 5 1 1 General Settings 36 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 6 JSON Communication 48 6 1 About JSON 49 6 2 Table of Resources 52 6 3 Resources 55 6 3 1 GET about 55 6 3 2 POST login 56 6 3 3 POS...

Page 6: ... serial energy conversionfactor 135 6 3 46 GET meters serial hardwareversion 137 6 3 47 GET meters serial mbusinfo 138 6 3 48 POST meters serial transformersettings 141 6 3 49 GET meters serial status 142 6 3 50 GET meters serial statusflags 143 6 3 51 GET meters serial events datetime count 146 6 3 52 GET meters serial alarms configuration 153 6 3 53 POST meters serial alarms configuration 156 6 ...

Page 7: ...GET meters serial demand configuration 213 6 3 79 POST meters serial demand configuration 216 6 3 80 DELETE meters serial demand 218 6 3 81 GET meters serial tariff 220 6 3 82 POST meters serial tariff 222 6 3 83 GET meters serial tariff dayprofiles 224 6 3 84 POST meters serial tariff dayprofiles 228 6 3 85 GET meters serial tariff weekprofiles 230 6 3 86 POST meters serial tariff weekprofiles 23...

Page 8: ...Table of Content G13 4 2CMC484002M0201 User Manual Revision A ...

Page 9: ... chapter describes the parts of the gateway and of the web interface It also explains the functions of the push buttons on the gateway and the behavior of the status 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 ...

Page 10: ...of the Gateway RESET Bus WPAN IR B A RS 485 C WPAN 1 2 3 4 5 7 8 9 10 12 13 14 15 16 17 6 11 11 14 18 5 G13 100 000 Item Part Comments 1 Not used 2 Ethernet socket 3 USB port For future usage 4 Product data MAC EUI address 5 Product data 6 IR Interface 7 LED A Power status 8 LED B Wired meter connection status 9 LED C Wireless meter connection status 10 Terminal block RS 485 connection 11 Sealing ...

Page 11: ...n to reduce intensity on the LEDs Reset button For Factory Settings press the button for 10 sec N Note When the reset button is engaged the reset indication will over ride all USB status indication on LED A RESET LED A Power status Behaviour In operation Steady green Power OFF OFF LED A USB status USB Initialize Flashes green twice USB Idle Steady green Data Transfer Continuous flashing green LED ...

Page 12: ...lo cation 3 Meter list A list of each meter in the selected location 4 Menu bar The main menu bar used for navigation 5 Username The username of the current active user 6 Logout Button to log out of the gateway 7 Location list List of selectable locations group of meters 8 Device name Device ID name or alias of the meter 9 Com status Status of the device Registered Online or Offline 10 Address Com...

Page 13: ...allation 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 ...

Page 14: ...nnect device should be incorporated external to the equipment Installation requirements Products with built in wireless communication should not be installed closer than 0 2 m from people Install the meter Follow the steps in the table below to install the Gateway Step Action 1 Turn off the main power 2 Place the Gateway on the DIN rail on the left side of the electrical meter and make sure it sna...

Page 15: ...l Installation 2 1 1 Wiring Diagrams Voltage RS 485 N Note For RS 485 signal A should be wired to A on the meter and equivalent for signals B and C M Bus N Note Wiring of M Bus is polarity independent 100 240 VAC C RS 485 A B 35 36 37 M Bus 36 37 ...

Page 16: ... Data Chapter 3 Technical Data Overview 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 ...

Page 17: ... 16 unit loads Protocol M Bus Baudrate 300 38400 bps Terminal wire area solid 0 05 1 5 mm2 Terminal wire area stranded 0 05 1 mm2 Recommended tightening torque 0 25 Nm Mechanical Enclosure material Polycarbonate Height 106 mm Width 70 mm Depth 65 mm Product weight 190 g Environmental Operating temperature range 25 C to 70 C Storage temperature range 40 C to 85 C Humidity 75 yearly average 95 on 30...

Page 18: ...2CMC489001M0201 14 G13 Revision A User Manual Technical Data Protection class Class II double isolation IP Class IP 20 Default IP address https 192 168 1 12 ...

Page 19: ...Technical Data G13 15 2CMC489001M0201 User Manual Revision A 3 2 Physical Dimensions G13 The following drawing shows the physical dimensions of the G13 gateway in mm 70 106 4 97 5 89 45 41 50 58 65 ...

Page 20: ...he gateway It also describes how to setup a gateway and how to add a meter In this chapter The following topics are covered in this chapter 4 1 User interface 17 4 2 Gateway Settings 21 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 ...

Page 21: ...ation Meter Events About Changes in the web interface are always executed to the meter by pressing the Send button The changes are confirmed with a small rectangular green or blue pop up window in the right lower corner If a red rectangle is represented then something is not correct or communication has failed From the web interface it is possible to configure meters Home Menu The Home menu displa...

Page 22: ...e and Setup Segment Menu The Segment menu shows the following options To access the Segment menu 1 Click the Segment button in the menu bar Location menu The Location menu shows the following options To access the Location menu 1 Click Location in the menu bar ...

Page 23: ...r menu shows the following options Depending on functionality of the Meter To access the Meter menu 1 Click Meter in the menu bar Events menu The Events menu shows the Gateway events To access the Events menu 1 Click Events in the menu bar To reset the Gateway Events 1 Click Reset About menu ...

Page 24: ...r Interface and Setup The About menu shows the following information about the gateway Firmware Version 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 ...

Page 25: ...User Interface and Setup 4 2 Gateway Settings Gateway settings The basic settings for the Gateway consists of the following Gateway Date Time Gateway Alias IP Configuration RS 485 Configuration N Note Only Gateway admin can change Gateway Settings ...

Page 26: ...the time from the computer clock To set Date Time 1 Click on date time in the field 2 Set date and time 3 Click Update 4 Press Send Gateway Alias and 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 ...

Page 27: ... Click Send To set IP address manually 1 Check the radio button Use the following IP addresses 2 Click the IP address field 3 Set the IP address 4 Click Send To obtain DNS server address automatically 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 t...

Page 28: ...2CMC489001M0201 24 G13 Revision A User Manual User Interface and Setup RS 485 Bus Configuration The baudrate is set to 500000 by default for RS 485 Bus To set the baudrate 1 Select baudrate 2 Click Send ...

Page 29: ...gment in the menu bar 2 Click Gateway firmware The current firmware version is shown in the upper part of the Gateway firmware square 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 ...

Page 30: ... of the Meter firmware square 3 Choose meters to update by clicking on them They will appear in the list on the right side 4 Click on Choose file and browse for preferred firmware version 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 N Note Maximum number of ten meters can be updated at the s...

Page 31: ...k Segment in the menu bar 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 Set device name 6 Click on the Save icon The floppy disk in the upper right of the meter square 7 Click Send To delete a meter click on the...

Page 32: ...ay The following chapters describe how to connect a meter to the gateway Login The following image shows the login to Energy Meter Gateway on https 192 168 1 12 To log on to the Gateway 1 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...

Page 33: ... configure a meter the meter has to be scanned and connected to the gateway via correct bus The menu is found under the Segment menu Select Device scan 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 ...

Page 34: ...eck Start end addresses or Specific addresses and set specific address addresses or check Secondary address 3 Select the same Baudrate corresponding to the baudrate in the meter 4 Press Scan Scan meter with 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 ...

Page 35: ...er 1 Set Location name by clicking on current name Write new location name 2 Set Device Alias by clicking on Device Name Write new meter alias 3 Press ADD 4 Press Send Changes are not made until data is sent 4 5 3 User Management Access level Distributing User Management from Segment User Management menu It is possible to set the meter access level for administrators and users in three levels No A...

Page 36: ...he Gateway update Gateway firmware and clear Event log To enable Gateway admin access 1 Click Segment menu 2 Click User Management 3 Click Admin 4 Check the Gateway Admin box 5 Click Send 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 ...

Page 37: ...irm password in Confirm Password field 5 Click Send N Note Gateway admin can set new password for users without the old password Change password To change password 1 Select Segment menu 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 ...

Page 38: ...agement 3 Click Add user located to the right 4 Set the new user name in the User Name field 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 N Note Username must only consist of lowercase letters and numbers from 0 9 ...

Page 39: ...ser Interface In this chapter The following topics are covered in this chapter 5 1 Setting and Configuration 36 5 1 1 General Settings 36 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 ...

Page 40: ...ation Demand Configuration Tariff Configuration Input Output Configuration Pulse Output Configuration Alarm Configuration Setting a Value When a value is changed the Send button sends the value to the meter 5 1 1 General Settings Ratio Settings To set the ratio perform the following steps 1 Select General Settings from the Meter Menu 2 Scroll down to Ratio Settings 3 Set the CT VT ratio by enterin...

Page 41: ...e meter has a built in clock the tariff source Clock can be used If the meter has Inputs the tariffs can be controlled by Inputs If the meter has communication the tariffs can be controlled by communication 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 ...

Page 42: ...ect Tariff from drop down menu 5 Click Send Resettable Energy Settings 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 ...

Page 43: ...ersion Factor Settings 3 Set the CO2 value 4 Set the Currency value 5 Click Send 5 1 2 Previous Value Configuration At the end of a defined period up to 23 configurable channels which can contain energy register values input counter values and currency CO2 values are stored together with the current time date and a snapshot is taken of the predefined val ues at the set period The period options ar...

Page 44: ...d 3 Select a value from the options list 4 Click OK 5 Click Send 5 1 3 Load Profile Configuration Each channel is configurable from the option window located to the right for each channel separately 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 ...

Page 45: ...ntervals 1 2 5 10 15 30 60 min 3 The Sub Interval can be set between 1 15 min depending on the selected interval Example If interval 1 60 minutes is chosen then the sub intervals between 1 2 5 10 30 60 minutes are available If interval 1 15 minutes is chosen then the sub intervals between 1 5 10 15 minutes are available Note that sub interval 2 is not available for interval 1 15 minutes since 15 i...

Page 46: ...sts of the tabs Day Week Season and Special Day The Save command saves locally all changes made while the Send command sends the changes made to the meter When the user leaves a tab all changes that have not been saved are discarded The Day tab Within the Day tab a list of switch points with Start time and Action can be set for each day profile There can be a maximum of 30 switch points per day an...

Page 47: ...2CMC489001M0201 43 G13 Revision A User Manual Meter Settings The Season tab Within the Season tab Season Profiles can be configured Remember to Save and Send The Special Day tab ...

Page 48: ...2CMC489001M0201 44 G13 Revision A User Manual 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 ...

Page 49: ... Input Output for a channel perform the following steps 1 Click a line from the Lines list 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 ...

Page 50: ...2CMC489001M0201 46 G13 Revision A User Manual Meter Settings 4 Set Frequency 5 Select Energy Type 6 Click Send ...

Page 51: ...he Alarms list 2 Select a value to configure from the option list below 3 Set On Threshold value for activation of the alarm 4 Set On Delay for delay of the alarm 5 Set Off Threshold value to set when the alarm is turned off 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 ...

Page 52: ... JSON Communication Chapter 6 JSON Communication Overview This chapter will address communication using the JSON protocol 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 ...

Page 53: ...er Gateway 1 0 Current version of API supports following HTTP verbs HTTP GET HTTP POST HTTP PUT HTTP DELETE MIME used with all types of http verbs is application json Authentication API is hosted by the Gateway Webserver via https end point Basic authentication mechanism is used for authentication However all traffic goes through SSL layers Thus all messages should have the following authorization...

Page 54: ...s arguments in URI as applicable Requests applicable to a particular meter will always start with meters serial Higher level resource meters returns list of all meters and their serial numbers Responses may vary depending on type of meter Example Phase angles are not supported in all types of meters Also there are some resources which are applicable in case of advanced meters only Harmonics are su...

Page 55: ...t would be error and description includes transaction reference at which the POST opera tion is aborted Note This might lead to inconsistent state of configuration Thus it is rec ommended to verify data in such cases Else send them individually Example When setting conversion factors for CO2 and Currency if server could update CO2 and fails to update Currency then the result would be error though ...

Page 56: ... GET gateway datetime 12 POST gateway datetime 13 GET gateway events 14 DELETE gateway events 15 POST gateway reboot 16 POST gateway execute 17 GET users 18 POST users user 19 PUT users 20 DELETE users user 21 GET users user bindings 22 PUT users user bindings 23 DELETE users user bindings 24 GET meters firmwareupdatestatus 25 POST firmware 26 PUT firmware 27 PUT meters firmware 28 GET parameterma...

Page 57: ...mode 56 GET meters serial energy resettable 57 POST meters serial energy resettable 58 GET meters serial energy resetcounter 59 GET meters serial power 60 GET meters serial instrument 61 GET meters serial harmonics voltage 62 GET meters serial harmonics current 63 GET meters serial io 64 GET meters serial io configuration 65 GET meters serial io pulse 66 POST meters serial io 67 POST meters serial...

Page 58: ...f 82 POST meters serial tariff 83 GET meters serial tariff dayprofiles 84 POST meters serial tariff dayprofiles 85 GET meters serial tariff weekprofiles 86 POST meters serial tariff weekprofiles 87 GET meters serial tariff seasonprofiles 88 POST meters serial tariff seasonprofiles 89 GET meters serial tariff specialdayprofiles 90 POST meters serial tariff specialdayprofiles 91 GET lasterror id ID ...

Page 59: ...Yes 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 Link lasterror 0 cosemversion 6 firmwareversion G0 0 0 0 hardwareversion model jsonapiversion 0 9 logicaldevicename ABBXXXXXXXXXXXXX releasedate 2012 08 30T14 06 26 serial 1234 ...

Page 60: ...1 1 401 Unauthorized Server embOS IP Accept Ranges bytes Content Type text html 6 3 2 POST login Creates a session for user with valid credentials Protected Yes Authentication required Request POST login HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Example https 192 168 1 12 login Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Link lasterror 0 Notes A successful resp...

Page 61: ...r 401 Unauthorized HTTP 1 1 401 Unauthorized Server embOS IP Accept Ranges bytes Content Length 162 Content Type text html HTML HEAD TITLE 401 Unauthorized TITLE HEAD BODY H1 401 Unauthorized H1 Browser not authentication capable or authentication failed BODY HTML 403 Forbidden HTTP 1 1 403 Forbidden Server embOS IP Accept Ranges bytes Content Length 36 Content Type text html X Pad avoid browser b...

Page 62: ...TP 1 1 401 Unauthorized Server embOS IP Accept Ranges bytes Content Length 162 Content Type text html HTML HEAD TITLE 401 Unauthorized TITLE HEAD BODY H1 401 Unauthorized H1 Browser not authentication capable or authentication failed BODY HTML 6 3 4 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 Protec...

Page 63: ...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 delay_before_requd2 200 get_request 0 meter_contact 0 response_timeout 0 response_timeout_base 800 mbus ir ack 1000 delay_after_telegram 1000 delay_before_requd2 200 get_request 0 meter_contact 0 response_timeout 0 resp...

Page 64: ...respective POST URI 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 5 POST configuration ip A POST call to configuration ip sets IP settings Protected Yes Authentication required ...

Page 65: ...alue of false means static ip setting and value of true means dynamic ip from dhcp server dns bool Value of false means pdns is the name server and value of true means dynamic dns from dhcp server ip string IP Address gateway string Gateway Address subnet string Subnet Mask Address pdns string Primary DNS Address sdns string Secondary DNS Address Notes With static IP settings DNS cannot be auto an...

Page 66: ...er embOS IP Accept Ranges bytes Content Length 57 Content Type application json status error des missing ip in JSON 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 6 POST configuration eqbus A POST call to configuration eqbus sets settings for e...

Page 67: ...ttimeout 1000 Description baudrate Int Supported baudrates are listed below 1200 2400 9600 19200 38400 57600 115200 125000 230400 460800 500000 interoctettimeout Int should be in between 20 and 6000 seconds Notes Baudrate settings are not propagated to meters This call changes baudrate in gate way only Users need to match settings in all meters using HMI of each meter Examples https 192 168 1 12 c...

Page 68: ...ept Ranges bytes Content Length 57 Content Type application json status error des missing baudrate in JSON 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 7 POST configuration mbus wired A POST call to configuration mbus wired sets timeout param...

Page 69: ...response_timeout 300 response_timeout_base 100 Description timeout values are expressed in seconds ack value should be between 200 and 2000 delay_after_telegram value should be between 50 and 60000 delay_before_requd2 should be between 50 and 1000 response_timeout should be between 300 and 15000 response_timeout_base should be between 100 and 10000 meter_contact should be between 10 and 25000 get_...

Page 70: ... IP Accept Ranges bytes Content Length 57 Content Type application json status error des missing baudrate in JSON 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 8 POST configuration mbus ir A POST call to configuration mbus ir sets timeout para...

Page 71: ...response_timeout 300 response_timeout_base 100 Description timeout values are expressed in seconds ack value should be between 200 and 2000 delay_after_telegram value should be between 50 and 60000 delay_before_requd2 should be between 50 and 1000 response_timeout should be between 300 and 15000 response_timeout_base should be between 100 and 10000 meter_contact should be between 10 and 25000 get_...

Page 72: ...Length 57 Content Type application json status error des missing baudrate in JSON 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 9 GET gateway A GET call to gateway returns alias location and serial Protected Yes Authentication required Request...

Page 73: ...XXX01 Description alias String 21 Gateway alias location String 51 Location of gateway serial String 17 Serial of gateway 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 10 POST gateway A POST call to gateway sets Gateway alias and location spec...

Page 74: ...Authorization Basic XXXXXXXXXXXXXXX Content Type application json Content Length 77 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 ...

Page 75: ...ror des missing datetime tag in JSON 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 11 GET gateway datetime A GET call to gateway datetime returns current date and time of gateway in stan dard date time format YYYY MM DDTHH MM SS Protected Yes ...

Page 76: ...time String Gateway Datetime status String 8 ClockStatus not set set 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 12 POST gateway datetime A POST call to gateway datetime sets specified date and time in standard date time format YYYY MM DDTHH...

Page 77: ...Revision A 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 ...

Page 78: ...application json status error des missing datetime tag in JSON 500 Server Internal 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 13 GET gateway events A GET call to gateway events returns the events log recorded by the gateway Protected Yes Authentication require...

Page 79: ...error 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 ...

Page 80: ...E_DELETED Device deleted from Gateway 8 GW_CONNECTIONLIMIT Gateway has reached its maximum connections 9 GW_METER_NOTCONNECTED Connection with meter lost 10 GW_REBOOT Gateway reboot initiated 11 GW_STARTED Gateway started 12 GW_EVENTS_RESET Gateway events are reset 13 GW_IP_ADDRESS_CHANGED Gateway IP address changed 14 GW_ALIAS_CHANGED Gateway alias changed 15 GW_LD_FW_UPLOAD_COMPLETE Firmware upl...

Page 81: ...LETE gateway events A DELETE call to gateway events clears event log of gateway Protected Yes Authentication required Request DELETE gateway events HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Example https 192 168 1 12 gateway events Response 200 Success HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 status success 6 3 15 POST gateway rebo...

Page 82: ...Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 status Rebooting 403 Forbidden HTTP 1 1 403 Forbidden Server embOS IP Accept Ranges bytes 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 appl...

Page 83: ...GY_IMPORT APPARENT_ENERGY_EXPORT APPARENT_ENERGY_NET POWER_FACTOR Differential VOLTAGE PHASE_ANGLE_POWER PHASE_ANGLE _VOLTAGE PHASE_ANGLE_CURRENT CURRENT_QUADRANT NRG_CONVERSION_FACTOR_CURR NRG_CONVERSION_FACTOR_CO2 ACTIVE_ENERGY_EXPORT for TARIFF1 to TARIFF4 REACTIVE_ENERGY_EXPORT for TARIFF1 to TARIFF4 REACTIVE_ENERGY_IMPORT for TARIFF1 to TARIFF4 ACTIVE_ENERGY_IMPORT for TARIFF1 to TARIFF4 NRG_...

Page 84: ...terface Class Id attributes value unit It contains array of attribute values for the given parameter to read It is dependent on interface class id value Int or String Parameter value attribute unit Int or String Parameter unit attribute This is optional 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 a...

Page 85: ...me Each device contains array values value unit for the given parameter to read value String holds the value of the given parameter to read unit String holds the unit of given parameter to read 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 6 3 17 GET users A GET...

Page 86: ...ent Length 64 Content Type application json status error des received invalid response from COSEM 6 3 18 POST users user A POST call to users user updates user information Protected Yes Authentication required Request 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 Usern...

Page 87: ...ied in payload takes precedence 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 name and key tag in JSON 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 ...

Page 88: ... only access rights to the newly added user Example https 192 168 1 12 users Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 status success 6 3 20 DELETE users user A DELETE call to users user removes specified user Protected Yes Authentication required Request DELETE users user HTTP 1 1 Host 192 168 1 12 Content Type applica...

Page 89: ...l to users user bindings returns list of access levels configured by administrator Protected Yes Authentication required Request GET users user bindings HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Examples https 192 168 1 12 users user3 bindings Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 bindings serial ABBXXXXXXXXXXXXX...

Page 90: ...nt Type application json status error des received invalid response from COSEM 6 3 22 PUT users user bindings A PUT call to users user bindings configures binding to a device Protected 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 Examp...

Page 91: ... harsha serial ABB_3 access No Access Example https 192 168 1 12 users harsha bindings Response 200 Success HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 status success 6 3 24 GET meters firmwareupdatestatus A GET call to meters firmwareupdatestatus returns firmware update status of each meter which is requested for upgrade Protected Yes A...

Page 92: ...areupdatecomplete 2 Description devices array of devices serial string 17 serial number of device status string pending success or failed firmwareupdatecomplete Int Indicates the status of firmware upgrade Values can be 0 update not initiated 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...

Page 93: ...on Content Length 1534226 Content Type multipart form data WebKitFormBoundary4pEAcghjNsS3M8L5 Content Disposition form data name image filename DSCF5183 JPG Content Type image jpeg WebKitFormBoundary4pEAcghjNsS3M8L5 Examples https 192 168 1 12 firmware Response 200 Success HTTP 1 1 200 OK Content Type text html charset utf 8 Content Length 20 Connection Keep Alive status success Description Update...

Page 94: ... error des missing name and key tag in JSON 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 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 1...

Page 95: ...d set of meters Note Applicable firmware image should be in gateway Please refer to POST firm ware Protected Yes Authentication required Request PUT meters firmware HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Content Type application json Content Length 35 meters ABBXXXXXXXXXX1101 Description meters Array of strings Array of serial numbers Max of 10 meters can be sent in per request At any time o...

Page 96: ... Content Length 57 Content Type application json status error des missing name and key tag in JSON 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 28 GET parametermapping A GET call to parametermapping returns the mapping list to be used as a re...

Page 97: ...JSON Communication G13 93 2CMC489001M0201 User Manual Revision A Request GET parametermapping Authorization Basic XXXXXXXXXXXXXXX Examples http 192 168 1 12 parametermapping ...

Page 98: ...T_TAR2 11 ACTIVE_ENERGY_IMPORT_TAR3 12 ACTIVE_ENERGY_IMPORT_TAR4 13 ACTIVE_ENERGY_NET_TOTAL 14 ACTIVE_ENERGY_NET_L1 15 ACTIVE_ENERGY_NET_L2 16 ACTIVE_ENERGY_NET_L3 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_...

Page 99: ...ATION_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 62 THD_VOLTAGE_L1_L2 63 THD_VOLTAGE_L2_L3 64 THD_VOLTAGE_L1_L3 65 THD_CURRENT_L1 66 THD_CURRENT_L2 67 THD_CURRENT_L3 68 THD_CURRENT_NEUTRAL 69 VOLTAGE_L1 70 CURRENT_L1 71 POWER_FAC...

Page 100: ...VE_POWER_L2 99 REACTIVE_POWER_L3 100 REACTIVE_POWER_TOTAL 101 APPARENT_POWER_L1 102 APPARENT_POWER_L2 103 APPARENT_POWER_L3 104 APPARENT_POWER_TOTAL 105 PHASE_ANGLE_POWER_L1 106 PHASE_ANGLE_POWER_L2 107 PHASE_ANGLE_POWER_L3 108 PHASE_ANGLE_POWER_TOTAL 109 PREVIOUS_VALUES 110 DEMAND 111 LOAD_PROFILE_CH_1 112 ALARM_SETTINGS_1 113 NRG_ENERGY_VALUE_CURR 114 TARIFF_CALENDAR_CONFIG 115 TARIFF_SPECIAL_DA...

Page 101: ...T_QUADRANT_L2 164 PHASE_ANGLE_VOLTAGE_L3 165 PHASE_ANGLE_CURRENT_L3 166 CURRENT_QUADRANT_L3 169 CURRENT_QUADRANT_TOTAL 170 FREQUENCY 171 RSTREG_ACT_ENERGY_IMP 172 RSTREG_ACT_ENERGY_EXP 173 RSTREG_REACT_ENERGY_IMP 174 RSTREG_REACT_ENERGY_EXP 175 RSTREG_ACT_CNTR_IMP 176 RSTREG_ACT_CNTR_EXP 177 RSTREG_REACT_CNTR_IMP 178 RSTREG_REACT_CNTR_EXP 179 HARMONICS_VOLTAGE_L1 180 HARMONICS_VOLTAGE_L2 181 HARMO...

Page 102: ...pt Ranges bytes Content Type text html 400 Bad Gateway HTTP 1 1 401 Invalid Request Server embOS IP Accept Ranges bytes Content Type text html 6 3 29 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 sto...

Page 103: ...1 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...

Page 104: ...onse from COSEM 6 3 30 GET meters serial 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 ...

Page 105: ...ex ACTIVE_ENERGY_IMPORT_TOTAL 1 ACTIVE_ENERGY_EXPORT_TOTAL 2 ACTIVE_ENERGY_IMPORT_L1 3 ACTIVE_ENERGY_IMPORT_L2 4 ACTIVE_ENERGY_IMPORT_L3 5 ACTIVE_ENERGY_EXPORT_L1 6 ACTIVE_ENERGY_EXPORT_L2 7 ACTIVE_ENERGY_EXPORT_L3 8 ACTIVE_ENERGY_IMPORT_TAR1 9 ACTIVE_ENERGY_IMPORT_TAR2 10 ACTIVE_ENERGY_IMPORT_TAR3 11 ACTIVE_ENERGY_IMPORT_TAR4 12 ACTIVE_ENERGY_NET_TOTAL 13 ACTIVE_ENERGY_NET_L1 14 ACTIVE_ENERGY_NET...

Page 106: ...SE_LENGTH_3 46 IO_PULSE_LENGTH_4 47 IO_PULSE_FREQUENCY_AE_1 48 IO_PULSE_FREQUENCY_AE_2 49 IO_PULSE_FREQUENCY_AE_3 50 IO_INPUT_CUMULATION_1 51 IO_INPUT_CUMULATION_2 52 IO_INPUT_CUMULATION_3 53 IO_INPUT_CUMULATION_4 54 IO_STORED_INPUT_STATE_1 55 IO_STORED_INPUT_STATE_2 56 IO_STORED_INPUT_STATE_3 57 IO_STORED_INPUT_STATE_4 58 THD_VOLTAGE_L1 59 THD_VOLTAGE_L2 60 THD_VOLTAGE_L3 61 THD_VOLTAGE_L1_L2 62 ...

Page 107: ...VE_ENERGY_EXPORT_TAR4 92 ACTIVE_POWER_L1 93 ACTIVE_POWER_L2 94 ACTIVE_POWER_L3 95 ACTIVE_POWER_TOTAL 96 REACTIVE_POWER_L1 97 REACTIVE_POWER_L2 98 REACTIVE_POWER_L3 99 REACTIVE_POWER_TOTAL 100 APPARENT_POWER_L1 101 APPARENT_POWER_L2 102 APPARENT_POWER_L3 103 APPARENT_POWER_TOTAL 104 PHASE_ANGLE_POWER_L1 105 PHASE_ANGLE_POWER_L2 106 PHASE_ANGLE_POWER_L3 107 PHASE_ANGLE_POWER_TOTAL 108 PREVIOUS_VALUE...

Page 108: ..._DESIGNATION 138 FIRMWARE_VERSION 139 TARIFF_INPUT_CONFIG 140 TRAFO_CT_RATIO_NUMERATOR 141 TRAFO_CT_RATIO_DENOMINATOR 142 TRAFO_VT_RATIO_NUMERATOR 143 TRAFO_VT_RATIO_DENOMINATOR 144 CLOCK 146 TARIFF_CALENDAR_CONFIG 147 TARIFF_CALENDAR_CONFIG 148 TARIFF_ACTIVE_DAY_TYPE 149 TARIFF_ACTIVE_SEASON 150 POWER_OUTAGE_TIME 151 POWER_FAIL_COUNTER 152 IO_PULSE_ENERGY_TYPE_4 153 IO_CURRENT_OUTPUT_STATE 154 CL...

Page 109: ...CS_VOLTAGE_L1_L2 182 HARMONICS_VOLTAGE_L2_L3 183 HARMONICS_VOLTAGE_L1_L3 184 HARMONICS_CURRENT_L1 185 HARMONICS_CURRENT_L2 186 HARMONICS_CURRENT_L3 187 HARMONICS_CURRENT_NEUTRAL 188 TARIFF_ACTIVE 189 TARIFF_SOURCE 190 HARDWARE_VERSION_0 191 HARDWARE_VERSION_1 192 HARDWARE_VERSION_2 193 HARDWARE_VERSION_3 194 HARDWARE_VERSION_4 195 HARDWARE_VERSION_5 196 HARDWARE_VERSION_6 197 HARDWARE_VERSION_7 19...

Page 110: ...OR_CURR 230 NRG_CONVERSION_FACTOR_CO2 231 TARIFF_CALENDAR_CONFIG 232 TARIFF_CALENDAR_CONFIG 233 TARIFF_CALENDAR_CONFIG 234 TARIFF_SPECIAL_DAYS_CONFIG 235 TARIFF_ACTIVE 236 TARIFF_SOURCE 237 TARIFF_INPUT_CONFIG 238 IO_CURRENT_OUTPUT_STATE 239 IO_SETTING 240 CLOCK_DST 241 Note 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 ...

Page 111: ...7 2CMC489001M0201 User Manual Revision A Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 associationobjects 1 1 1 1 1 1 1 1 1 role View Only serial ABB_1 ...

Page 112: ...rial number 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 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 E...

Page 113: ... 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 alias ABB_9 serial ABB_9 protocol 1 address 18 status 1 location Level2 serial meters alias ABB_6 serial ABB_6 protocol 1 address 12 status 1 ...

Page 114: ... metering meters Array Array of meter objects alias String 21 Alias name of the meter serial String 17 Serial number of meter protocol Int Backplane protocol over which meter is registered M Bus Wired 1 M Bus IR 2 EQ bus 3 Wireless 4 address Int Address of meter for this protocol In case of wireless this would be the Mac address status Int Status of connectivity Offline 1 Registered 0 Online 1 500...

Page 115: ...ion 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 location String 51 Gateway location name serial String 17 Gateway serial number Examples https 192 168 1 12 meters ABB_2 ...

Page 116: ... 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 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 ...

Page 117: ... 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 Examples https 192 168 1 12 meters ...

Page 118: ...t 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 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 wit...

Page 119: ...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 ...

Page 120: ...th 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 Content Length 64 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 met...

Page 121: ...y of scanned meter objects token Int token for scan serial String 17 Serial Number of scanned meter protocol Int Protocol M Bus Wired 1 M Bus IR 2 EQ bus 3 Wireless 4 address String Address of meter for this protocol In case of wireless this would be the Mac address scancomplete Int Complete 1 or In progress 2 500 Internal Server Error HTTP 1 1 500 Internal Server Error Server embOS IP Accept Rang...

Page 122: ...118 G13 Revision A User Manual 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 ...

Page 123: ...us HDLC addresses can be specified in two ways In the form of start 17 and end 49 or a range devices of up to 10 addresses mbus wired MBus addresses can be specified in two ways In Primary start 1 end 16 and baudrate OR range devices of up to 10 addresses and baudrate Secondary and baudrate No input needs to be provided for the secondary scan It makes a search in which it will find all slaves rega...

Page 124: ...n secondary addressing mode mbus wired baudrate 19200 secondary mbus ir baudrate 4800 secondary token 1342527820 Here mbus wired and mbus ir are specified in primary addressing mode mbus wired baudrate 38400 start 1 end 16 mbus ir bau drate 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 htt...

Page 125: ...ver 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 Content Length 64 Content Type application json status error des received invalid response from COSEM 6 3 37 DELETE meters scanned A DELETE call to meters scanned deletes requested devices...

Page 126: ...ed Array of objects Array of scanned meter objects serial String 17 Serial Number of scanned meter Note Request sent without any payload empty deletes all scanned meters Maximum meters specified in payload should not exceed 15 Examples https 192 168 1 12 meters scanned Response 200 Success HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 dele...

Page 127: ...y from scan list 1 meter is not found in the scan list 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 6 3 38 GET permittedmeters A GET call to permittedmeters returns list of permitted wireless meters Protected Yes Authentication required Request GET permittedmeters HTTP 1 1 Authorizatio...

Page 128: ...XXXXXXXX3 Description meters Array of serial numbers string 17 Note At any time max of 25 serial numbers can be specified 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 39 PUT permittedmeters A PUT call to permittedmeters adds a new meter to li...

Page 129: ...uest 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 ...

Page 130: ...rver embOS IP Accept Ranges bytes Content Length 57 Content Type application json status error des missing datetime tag in JSON 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 40 DELETE permittedmeters A DELETE call to permittedmeters deletes me...

Page 131: ...A 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 ...

Page 132: ...on json status error des missing datetime tag in JSON 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 41 GET meters serial datetime A GET call to meters serial datetime returns datetime settings of meter Protected Yes Authentication required Req...

Page 133: ... Response 200 OK 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 status set ...

Page 134: ... DST disabled dstend String DST end date time dststart String DST start date time status String 8 ClockStatus not set set 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 42 POST meters serial datetime A POST call to meters serial datetime update...

Page 135: ...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 dstenable to false POST datetime dstenable dststart dstend Note Thus if dstenable is set to true then the user should also send dststart and dstend If dstenable is set to false then dststart dstend will be ignore...

Page 136: ...TTP 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 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...

Page 137: ...ontent 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 currency 100 789 curr kWh power powerfailcounter 4 poweroutagetime 0 ...

Page 138: ...f power outage time in seconds powerfailcounter Int General counter of powerfail conversion factor Object Object of conversion factors co2 Array co2 conversion factor and unit currency Array currency conversion factor and unit 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 in...

Page 139: ... Array co2 conversion factor and unit currency Array currency conversion factor and unit 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 45 POST meters serial energy conversionfactor A GET call to meters serial conversionfactor updates co2 and c...

Page 140: ...onversionfactor co2 1 123 currency 100 789 Description co2 Double Int co2 conversion factor value should be less than 9 999 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 ...

Page 141: ... 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 Protected Yes Authentication required Request GET meters serial hardwareversion HTTP 1 1 Authorization Basic XX...

Page 142: ...IJKLMNOP_5 ABCDEFGHIJKLMNOP_6 ABCDEFGHIJKLMNOP_7 Description Version is an array of version numbers up to 8 components Each version number is string18 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 47 GET meters serial mbusinfo A GET call to me...

Page 143: ...l mbusinfo HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Examples https 192 168 1 12 meters ABB_8 mbusinfo Response 200 OK 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 ...

Page 144: ... flow temperature inlet 0B Heat Volume measured at flow temperature inlet 0C Heat Cooling load meter 0D Bus System component 0E Unknown Medium 0F Hot water 90 C 15 Cold Water 16 Dual register hot cold Water 17 Pressure 18 A D Converter 19 addressingmode int Primary Any value 0 250 or 0xFF Secondary 0xFD version int version number id int Four digits 500 Internal Server Error HTTP 1 1 500 Internal S...

Page 145: ...XXXXXXXXX ctnum 1 ctdenum 1 vtnum 1 vtde num 1 Description ctnum Int CT numerator ctdenum Int CT de nominator vtnum Int VT numerator vtdenum Int VT de nominator Examples https 192 168 1 12 meters ABB_8 transformersettings Response 200 OK 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 Int...

Page 146: ...nication status of requested meter 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 ...

Page 147: ... 2 Single phase indirect connected 3 Three phase direct connected 4 Three phase indirect connected Type of meter 0 Iron 1 Steel 2 Bronze 3 Silver 4 Gold 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 Server embOS IP Accept Ranges bytes Content Length 64 Content ...

Page 148: ...rization Basic XXXXXXXXXXXXXXX Examples https 192 168 1 12 meters ABB_8 statusflags Response 200 OK 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 ...

Page 149: ...pecific Str 4 ABB Specific Str 5 ABB Specific Str 6 ABB Specific Str 7 ABB Specific Str 8 warnings Array of String Object of active warnings Array may include U1 Missing U2 Missing U3 Missing Phase Conn Neutral NEG_POW Element1 NEG_POW Element2 NEG_POW Element3 Neg Tot Pow Frequency External Input Date Not Set Time Not SET informationflags Array of String Object of active information flags Array m...

Page 150: ...22 Active Alarm23 Active Alarm24 Active Alarm25 Active Pulses Merged Powerfail 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 51 GET meters serial events datetime count A GET call to meters serial events datetime count returns events logged in ...

Page 151: ...XXXXXXXXXXXX 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 requested Max value can be 100 Example https 192 168 1 12 meters ABB_8 events 2012 05 15T13 43 00 https 192 168 1 12 meters ABB_8 events 2012 05 15T13 43 00 25 ...

Page 152: ...ing chunked Link lasterror 0 system datetime 2011 12 19T10 12 00 duration 0 category 2 logid 1001 datetime 2011 12 18T10 12 00 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 ...

Page 153: ...JSON Communication G13 149 2CMC489001M0201 User Manual Revision A datetime 2011 12 18T10 12 00 duration 0 category 2 logid 1003 ...

Page 154: ...able Error 40 AUDIT_LOG_ERROR Audit log error 41 PROGRAM_CRC_ERROR Program CRC error 42 PERSISTENT_STORAGE_ERROR Persistent memory storage error 43 ABB_SPECIFIC_STR_1_ERROR ABB sepcific STR 1 error 44 ABB_SPECIFIC_STR_2_ERROR ABB sepcific STR 2 error 45 ABB_SPECIFIC_STR_3_ERROR ABB sepcific STR 3 error 46 ABB_SPECIFIC_STR_4_ERROR ABB sepcific STR 4 error 47 ABB_SPECIFIC_STR_5_ERROR ABB sepcific ST...

Page 155: ...POW_WARNING Negative total power warning 1008 FREQUENCY_WARNING Frequency warning 1009 EXTERNAL_INPUT_WARNING External Input warning 1010 DATE_NOT_SET_WARNING Date is not set warning 1011 TIME_NOT_SET_WARNING Time is not set warning Information 2013 ALARM1_ACTIVE_INFO Alarm 1 Active information 2014 ALARM2_ACTIVE_INFO Alarm 2 Active information 2015 ALARM3_ACTIVE_INFO Alarm 3 Active information 20...

Page 156: ...rm 18 Active information 2031 ALARM19_ACTIVE_INFO Alarm 19 Active information 2032 ALARM20_ACTIVE_INFO Alarm 20 Active information 2033 ALARM21_ACTIVE_INFO Alarm 21 Active information 2034 ALARM22_ACTIVE_INFO Alarm 22 Active information 2035 ALARM23_ACTIVE_INFO Alarm 23 Active information 2036 ALARM24_ACTIVE_INFO Alarm 24 Active information 2037 ALARM25_ACTIVE_INFO Alarm 25 Active information 2054...

Page 157: ...nse 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 ...

Page 158: ...json Server embOS IP Transfer Encoding chunked Link lasterror 0 alarmconfig id 1 quantity 75 onthreshold 310 offthreshold 0 ondelay 240 offdelay 0 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 ...

Page 159: ...g Bool boolean says log is true or false output Int outport number 1 to 4 Notes If a channel is inactive then it contains id parameter only For example id 1 400 Bad Request HTTP 1 1 400 Bad Request Server embOS IP Accept Ranges bytes Content Length 64 Content Type application json status error des Invalid Request 502 Internal Server Error HTTP 1 1 500 Internal Server Error Server embOS IP Accept R...

Page 160: ...ST meters lt serial alarms configuration HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Content Type application json Content Length 197 alarmconfig id 25 quantity 70 onthreshold 0 offthreshold 0 ondelay 0 offdelay 0 log true output 1 Description id Int Alarm number 1 to 25 quantity Int quantity index as per parametermapping onthreshold Int threshold level offthreshold Int threshold level ondelay In...

Page 161: ...K 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 name and key tag in JSON 502 Internal Server Error HTTP 1 1 500 Internal Server Error Server embOS IP Accept Ranges bytes Content Length 64 Cont...

Page 162: ...rt energy Energy exported to utility is measured as export energy Differential value is measured as net energy Net energy could be negative when export is more than import For simple cases total energy would be a choice Protected Yes Authentication required Request GET meters serial energy type mode HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Parameters type active reactive apparent Note Not all ...

Page 163: ...ion A Response 200 OK 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 t4 0 01 kWh total 1271 31 kWh ...

Page 164: ...Revision A User Manual JSON Communication exportenergy l1 77587522 36 kWh l2 12718357 27 kWh l3 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 ...

Page 165: ...energy Object Object of net energy lx Array line net energy and unit x can be 1 to 3 total Array total net energy and unit 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 55 GET meters serial energy type mode A GET call to meters serial energy t...

Page 166: ...ples https 192 168 1 12 meters ABB_8 energy active co2 https 192 168 1 12 meters ABB_8 energy active currency Response 200 OK HTTP 1 1 200 OK Content Type application json 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 js...

Page 167: ...rgy resettable returns resettable energy values of requested meter Meters are capable of maintaining resettable registers These can be reset as needed by user Reset counter is incremented each time these registers are reset Resettable energy could include active import active export reactive import and reactive export energies Protected Yes Authentication required Request GET meters serial energy ...

Page 168: ...718359 562 Wh activeimport 1758397 363 Wh 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 Description resettable energy combination of active import and export energies activeimport array value of active import and unit activeexport array value of a...

Page 169: ...d each time resettable energy registers are reset User can reset any one or all of following registers 1 activeimport 2 activeexport 3 reactiveimport 4 reactiveexport Protected Yes Authentication required Request POST meters serial energy resettable HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX resettableenergy activeimport true activeexport true reactiveimport true reactiveexport true Examples htt...

Page 170: ...tion json status error des received invalid response from COSEM 6 3 58 GET meters serial energy resetcounter A GET call to meters serial energy resetcounter returns reset count of resetta ble energy values of requested meter Reset counter is incremented each time these registers are reset It holds number of times the resettable registers are reset Protected Yes Authentication required Request GET ...

Page 171: ... Length 64 Content Type application json status error des received invalid response from COSEM Description reset counter combination of active import and export energy reset counts activeimport array value of active import activeexport array value of active export 6 3 59 GET meters serial powers A GET call to meters serial power returns realtime power values of requested meter Protected Yes Authen...

Page 172: ... 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 active l1 2000001 W l2 2000002 W l3 2000003 W total 2000000 W reactive l1 100000 W l2 1000002 W l3 1000003 W total 100000 W apparent l1 1100001 W l2 1100002 W l3 1100003 W total 1100004 W ...

Page 173: ...ergy lx Array Apparent line power and unit x can be 1 to 3 total Array Total apparent power and unit 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 60 GET meters serial instrument A GET call to meters serial instrument returns realtime voltage ...

Page 174: ...nt 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 volt...

Page 175: ...JSON Communication G13 171 2CMC489001M0201 User Manual Revision A voltage 251 920 V neutral current 0 00 A total currentquadrant 0 phaseanglepower 0 00 deg powerfactor 0 000 frequency frequency 49 78 Hz ...

Page 176: ...nit l1 l3 Object Object of line values voltage Array voltage between l1 and l3 and unit neutral Object Object of neutral current values current Array neutral current and unit total Object Object of total values currentquadrant Array total currentquadrant and unit is null phaseanglepower Array total phaseanglepower and unit powerfactor Array total powerfactor and unit is null frequency Object Objec...

Page 177: ...ommunication G13 173 2CMC489001M0201 User Manual Revision A Request GET meters serial harmonics voltage HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Examples https 192 168 1 12 meters ABB_8 harmonics voltage ...

Page 178: ...User Manual JSON Communication Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 l1 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 ...

Page 179: ...JSON Communication G13 175 2CMC489001M0201 User Manual Revision A 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 0 0 0 0 0 ...

Page 180: ...2CMC489001M0201 176 G13 Revision A User Manual JSON Communication 0 0 0 thd 0 l2 l3 harmonics 0 0 0 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 ...

Page 181: ...OS IP Accept Ranges bytes Content Length 64 Content Type application json status error des received invalid response from COSEM 6 3 62 GET meters serial harmonics current A GET call to meters serial harmonics current returns current harmonic val ues of requested meter Protected Yes Authentication required Request GET meters serial harmonics current HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Exam...

Page 182: ...User Manual JSON Communication Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 l1 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 ...

Page 183: ...JSON Communication G13 179 2CMC489001M0201 User Manual Revision A 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 0 0 0 0 0 ...

Page 184: ...ror 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 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 ...

Page 185: ...Revision A Response 200 OK 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 ...

Page 186: ...input Applicable in case of Input only 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 64 GET meters serial io configuration A GET call to meters serial io configuration returns configuration of Input and Outputs Protected Yes Authentication req...

Page 187: ...r 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 always_on always_off dont_change 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 188: ... 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 ...

Page 189: ...cation 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 energytype reactive_export port 255 ...

Page 190: ..._import 0 active_export 1 reactive_import 2 reactive_export 3 turned_off 4 invalid 0xff port int Port number 1 4 or 255 Turned Off 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 66 POST meters serial io A POST call to meters serial io updates I...

Page 191: ...sion A 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 ...

Page 192: ...state iostatus port 1 currentstate 0 port 2 reset storedstate counter Port1 as output and its state is set to OFF state Port2 as input and its reset array contains storedstae counter iostatus port 1 currentstate 0 port 2 reset storedstate counter Port1 as output and its state is set to OFF state Port4 as output and it s state is set to ON state iostatus port 1 currentstate 0 port 4 currentstate 1 ...

Page 193: ...terror 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 Protected Yes Authentication required ...

Page 194: ...ent Type application json Content Length 22 ioconfig 3 5 4 2 Description ioconfig Array of Input and outputs Array can contain up to 4 elements The following code to be provided for specific port Input 0 Communication Out 1 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 ...

Page 195: ...ked 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 Protected Yes Authentication required ...

Page 196: ...al io pulse HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Content Type application json Content Length 398 pulse id 1 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 ...

Page 197: ...e Energy types are active_import 0 active_export 1 reactive_import 2 reactive_export 3 turned_off 4 invalid 0xff port int Port number 1 4 or 255 Turned Off Note There are 4 pulse outputs Any pulse output can be assigned to any port Thus each of pulse description to include id field specifying pulse output 1 2 3 or 4 Then specify port to assign Pulse output can be turned off by specifying port numb...

Page 198: ...lid response from COSEM 6 3 69 GET meters serial previousvalues fromdate count todate A GET call to meters serial previousvalues fromdate count todate re turns previous values for the given combinations from date and count between from date to date Protected Yes Authentication required Request GET meters serial previousvalues fromdate count todate HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Descr...

Page 199: ...012 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 Link lasterror 0 mapping active_import_total Wh active_export_total Wh interval daily items 1 0 000 1 0 000 time 2012 07 23T00 00 00 1 0 000 1 0 000 time 20...

Page 200: ...step Else conclude as data not available 3 If bit2 is set it is a power off scenario Else it is good and OK status Time tag provides each interval end time during which values are captured 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 70 GET m...

Page 201: ...7 Sunday pvconfig This is an array of channel ID mapped to storablequantities 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 71 POST meters serial previousvalues configuration A POST call to meters serial previousvalues configuration configures...

Page 202: ... Type application json Content Length 93 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 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 ...

Page 203: ... 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 Protected Yes Authentication required Request DELETE meters serial previousvalues HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Examp...

Page 204: ... lasterror 0 status error des received READ_WRITE_DENIED response from COSEM 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 73 GET meters serial loadprofiles channel fromdate count todate A GET call to meters serial loadprofiles channel fromdat...

Page 205: ... loadprofiles channel from count to HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Examples Following are the possible scenarios from date and count https 192 168 1 12 meters ABB_8 loadprofiles 2012 07 01T01 00 00 100 from date and to date https 192 168 1 12 meters ABB_8 loadprofiles 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 loadprof...

Page 206: ...hanged during snapshot interval BIT5 0x20 Bad value means accumulator value is not correct BIT6 0x40 Reserved BIT7 0x80 Reserved 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 74 GET meters serial loadprofiles configuration A GET call to meters...

Page 207: ...M0201 User Manual Revision A Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 lpconfig 60 1 15000 120 69 7000 21600 72 2000 180 75 5000 3600 78 1000 600 79 2000 450 80 ...

Page 208: ...uantities list Item count Int Sum of all item counts in 8 channels should not exceed 40000 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 75 POST meters serial loadprofiles configuration A POST call to meters serial loadprofiles configuration c...

Page 209: ...JSON Communication G13 205 2CMC489001M0201 User Manual Revision A Request POST meters serial loadprofiles configuration HTTP 1 1 ...

Page 210: ...01 206 G13 Revision A User Manual JSON Communication Authorization Basic XXXXXXXXXXXXXXX Content Type application json Content Length 205 lpconfig 60 1 15000 120 69 7000 21600 72 2000 180 75 5000 3600 78 1000 600 79 ...

Page 211: ...nterval Int interval in seconds Possible values are 1m 2m 3m 5m 10m 15m 30m 1h 2h 3h 6h 12h 1d Ex 5 mins will be represented as 300 secs quantity Int Quantity is the index of measurement parameter from storablequantities list Item count Int Sum of all item counts in 8 channels should not exceed 40000 Examples https 192 168 1 12 meters ABB_8 loadprofiles configuration ...

Page 212: ... Length 64 Content Type application json status error des received invalid response from COSEM 6 3 76 DELETE meters serial loadprofiles A DELETE call to meters serial loadprofiles clears LoadProfile values Protected Yes Authentication required Request DELETE meters serial loadprofiles channel HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX Description Channel is optional When omitted it erases all ch...

Page 213: ...ror 0 status error des received READ_WRITE_DENIED response from COSEM 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 77 GET meters serial demand fromdate count todate A GET call to meters serial demand channel fromdate count todate returns dema...

Page 214: ...DDTHH MM SS form data is requested from this time count count can be up to 500 todate datetime in 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 ...

Page 215: ...P 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 ...

Page 216: ... 2012 06 16T02 40 00 3 time 2012 06 17T00 00 00 Description mapping Configuration map Items contains array of snapshot values Array of arrays Inner array is as per format described below status value time stamp level status 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 ...

Page 217: ...level For indicative purposes But whether it is max min demand to be derived from demand code in configuration Time tag provides each interval end time during which the demand values are captured 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 7...

Page 218: ...ision A User Manual JSON Communication Response 200 OK 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 ...

Page 219: ...n 3 3 1 Max 1 5 1 Max 2 6 1 Max 3 7 2 Min 1 9 2 Min 2 10 2 Min 3 11 2 Max 1 13 2 Max 2 14 2 Max 3 15 period period can be daily weekly or monthly week day Week day is applicable if period is week And values are 1 Monday to 7 Sunday interval Interval to be specified as array of interval subinterval in seconds Valid values are 60 1 min 120 2 min 180 3 min 300 5 min 600 10 min 900 15 min 1800 30 min ...

Page 220: ...lid response from COSEM 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 Protected Yes Authentication required ...

Page 221: ...hannels interval 900 60 period weekly weekday 2 Description dmc This is array of configuration of each channel Array sequence is formatted as QuantityId Dem and Code QuantityID is ID from storable quantities Demand code is encoded with billing period demand type and level as below Billing Demand Level Code 1 Min 1 1 1 Min 2 2 1 Min 3 3 1 Max 1 5 1 Max 2 6 1 Max 3 7 2 Min 1 9 2 Min 2 10 2 Min 3 11 ...

Page 222: ... 5 min 600 10 min 900 15 min 1800 30 min and 3600 60 min Examples https 192 168 1 12 meters ABB_8 demand configuration Response 200 OK 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 ...

Page 223: ...n 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 HTTP 1 1 502 Internal Server Error Server embOS IP Accept Ranges bytes Content Length 64 Content Type application j...

Page 224: ...ization Basic XXXXXXXXXXXXXXX Examples https 192 168 1 12 meters ABB_8 tariff Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 daytype 2 season 1 tariff 1 source 1 Description 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 season...

Page 225: ... to 4 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 element of array is described below Input 4 Input 3 1 OFF OFF 2 OFF ON 3 ON OFF 4 ON ON Note input is available only if source as Input 500 Internal Server Error HTTP 1 1 500 Internal Server Error Server embOS...

Page 226: ...rs ABB_3 tariff HTTP 1 1 Host 192 168 1 12 Content Length 12 Authorization Basic XXXXXXXXXXXXXXX tariff 2 Examples https 192 168 1 12 meters ABB_8 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 Ex...

Page 227: ...t 3 1 OFF OFF 2 OFF ON 3 ON OFF 4 ON ON Note If source is configured as Input then only user can configure the tariff input User can set source alone or with tariff or with input Response 200 OK 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 R...

Page 228: ...l 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 ...

Page 229: ...01 User Manual Revision A Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 dayprofiles actions 1 00 00 2 12 00 profile 0 actions 2 12 00 3 15 00 profile 1 actions 9 02 00 ...

Page 230: ...2CMC489001M0201 226 G13 Revision A User Manual JSON Communication profile 2 actions 11 03 00 profile 3 actions 1 04 00 profile 4 actions 2 05 00 profile 5 actions 3 06 00 profile 6 actions 1 07 00 ...

Page 231: ...JSON Communication G13 227 2CMC489001M0201 User Manual Revision A profile 7 actions 2 08 00 profile 8 actions 1 09 00 profile 9 ...

Page 232: ...tion Id refers the following actions 1 actionactivatetariff_1 2 actionactivatetariff_2 3 actionactivatetariff_3 4 actionactivatetariff_4 5 actionsetoutput_1 6 actionresetoutput_1 7 actionsetoutput_2 8 actionresetoutput_2 9 actionsetoutput_3 10 actionresetoutput_3 11 actionsetoutput_4 12 actionresetoutput_4 500 Internal Server Error HTTP 1 1 500 Internal Server Error Server embOS IP Accept Ranges b...

Page 233: ...ed Action Id refers to the following actions 1 actionactivatetariff_1 2 actionactivatetariff_2 3 actionactivatetariff_3 4 actionactivatetariff_4 5 actionsetoutput_1 6 actionresetoutput_1 7 actionsetoutput_2 8 actionresetoutput_2 9 actionsetoutput_3 10 actionresetoutput_3 11 actionsetoutput_4 12 actionresetoutput_4 startime String Action stattime Note If the profile has only one action then the act...

Page 234: ...ror Server embOS IP Accept Ranges bytes Content Length 64 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 Protected Yes Authentication required Request GET meters serial tariff weekprofiles HTTP 1 1 Authorization Basic XXXXXXXXXXXXXXX ...

Page 235: ...User Manual Revision A Response 200 OK HTTP 1 1 200 OK Content Type application json Server embOS IP Transfer Encoding chunked Link lasterror 0 weekprofiles dayid 1 4 2 5 3 6 1 profile Week1 dayid 1 2 3 7 5 6 7 profile Week2 dayid 7 6 5 4 3 2 1 ...

Page 236: ... of dayprofile to execute Refer DayProfileId from metersgetdayprofile 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 86 POST meters serial tariff weekprofiles A POST call to meters serial tariff weekprofiles updates weekprofiles config uration ...

Page 237: ...ekprofiles 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 Refer DayProfileId from metersgetdayprofile Examples https 192 168 1 12 meters ABB_8 tariff weekprofiles ...

Page 238: ...er Error Server embOS IP Accept Ranges bytes Content Length 64 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 ...

Page 239: ...se 200 OK 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: ...e Refer weekname from metersgetweekprofile 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 88 POST meters serial tariff seasonprofiles A POST call to meters serial tariff seasonprofiles updates seasonprofiles con figuration Protected Yes Authent...

Page 241: ...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 weekprofile String weekprofile name to execute Refer weekname from metersgetweekprofile Examples https 192 168 1 12 meters ...

Page 242: ...S IP Accept Ranges bytes Content Length 64 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 Protected Yes Authentication required Request GET meters serial tariff specialdayprofiles HTTP 1 1 Authorization Basic XXXXXXX...

Page 243: ... 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 date day 1 month 9 week 255 year 65535 dayprofile 14 profile 3 ...

Page 244: ...pt Ranges bytes Content Length 64 Content Type application json status error des received invalid response from COSEM 6 3 90 POST meters serial tariff specialdayprofiles A POST call to meters serial tariff specialdayprofiles updates specialdaypro files configuration for matched date If there is no match then it adds a new entry If profileid already exists but it doesn t match with specified date t...

Page 245: ...e Object SpecialDay Date dayprofileid day profile id to execute Refer DayProfileId from metersgetdayprofile Examples https 192 168 1 12 meters ABB_8 tariff specialdayprofiles Response 200 OK 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 Range...

Page 246: ... client receives a 200 header but gets a parse error as body is not fully formatted To be able to diagnose the error condition clients can call this resource to get details of error Protected Yes Authentication required Request GET lasterror lt id Authorization Basic XXXXXXXXXXXXXXX Examples https 192 168 1 12 lasterror 23 Response 200 Successful HTTP 1 1 200 OK Content Type application json Serve...

Page 247: ...etitive 2 Electronics Basic Low 3 Electronics Basic High 4 Electronics Advanced 5 Electronics Multimeter 96 x 96 6 Electronics Analyzer 96 x 96 Z stands for type of phase 1 Single phase direct connected 2 Single phase indirect connected 3 Three phase direct connected 4 Three phase indirect connected A stands for type of functionality level of meter 0 Functionality level Iron 1 Functionality level ...

Page 248: ... approved abd verified 3 IEC approved 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 3 BHM version 3 4 BHM version 4 5 BHM version 5 6 BHM version 6 7 BHM version 7 8 BHM version 8 9 BHM version 9 A BHM version A Examples A44 512 100 3 phase ind...

Page 249: ...JSON Communication G13 245 2CMC489001M0201 User Manual Revision A ...

Search results

Summary of Contents for G13

Reviews:

Related manuals for G13

Brands by name

Popular brands

ABB G13, User Manual

Search results

Summary of Contents for G13

Reviews:

Related manuals for G13

Brands by name

Popular brands