Metering Device Operation Flow
- Sacha Parisot (Unlicensed)
The IAP Device resource is a collection of objects in the request and feedback channels. Each set of IAP device objects represents one physical device and its interface with datapoints, properties and so on.
IOX supports upto three phase metering which is user configurable. Default is three phase metering. Following are the few important parameters for metering device:
- Voltage
- Current
- Energy(Active/Reactive/apparent)
- Power(Active/Reactive/apparent)
- Power Factor
The supported do actions are: add, create, deprovision, delete, file action, load, message, provision, remove, repair, replace, reset, routing, test, and wink. You can publish an action object to the object's do endpoint to invoke the action.
glp/0/{SID}/rq/dev/[{Edge_Protocol_ID}/{Handle}]/do |
---|
The format of Edge_Protocol_ID is iox.<6Digit_Mac_Address>. In the examples below "iox.409eb1" is being used as the edge protocol id.
Flow of operations are
- Metering Device Creation and Provisioning
- Request for monitoring configuration
- Response from IOX to Apollo on feedback channel for metering data
- Response from IOX to monitoring service
- Metering device deprovisioning
1. Metering Device Creation and Provisioning
Request:
The topic for creating metering device will be "glp/0/SID/rq/dev/IOX_HANDLE/meter/do" and the action object from the message should be "create".
glp/0/144/rq/dev/iox.409eb1/meter/do { "action":"create", "args": { "unid":"257", "type":"meter", "provision":true } }
This will creates the DIO device, publishes its status and configuration objects in the feedback channel and leaves the device in the provisioned state due to passing optional provision argument.
Response:
Create DIO Device will response on the feedback channel with the configuration and status on the topic "glp/0/SID/fb/dev/IOX_HANDLE/dio/[cfg/sts]".
glp/0/144/fb/dev/iox.409eb1/meter/cfg { "name": "meter", "desc": "IOX Metering Device", "motion_zone": 0, "motion_radius": 0, "motion_timeout": 0, "loc": { "desc": "", "lat": 0, "lng": 0 } } glp/0/144/fb/dev/iox.409eb1/meter/sts { "state": "unprovisioned", "unid": "257", "health": "normal", "cat": "metering", "type": "meter", "interfaceType": "static", "usage": "mixed", "version": "1.0.0" } glp/0/144/fb/res/type/8000010500000000-4/UNVT_current_3ph { "class": "datapoint", "id": "UNVT_current_3ph", "key": 1, "name": "Instantaneous RMS current", "comment": "This datapoint reports instantaneous RMS current for up to three phases", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "reference", "id": "L1_current", "name": "L1_current", "comment": "Phase L1 (A) instantaneous current reading", "reference": "SNVT_amp_f", "unit": "A" }, { "type": "reference", "id": "L2_current", "name": "L2_current", "comment": "Phase L2 (B) instantaneous current reading", "reference": "SNVT_amp_f", "unit": "A" }, { "type": "reference", "id": "L3_current", "name": "L3_current", "comment": "Phase L3 (C) instantaneous current reading", "reference": "SNVT_amp_f", "unit": "A" }, { "type": "reference", "id": "average_current", "name": "Average Current", "comment": "Average instantaneous RMS current for active phases", "reference": "SNVT_amp_f", "unit": "A" }, { "type": "reference", "id": "neutral_current", "name": "Neutral current", "comment": "Neutral instantaneous RMS current", "reference": "SNVT_amp_f", "unit": "A" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_energy_i64 { "class": "datapoint", "id": "UNVT_energy_i64", "key": 3, "name": "energy summation of all phases", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "scalar", "id": "total", "name": "Total energy", "comment": "Energy summation of all phases", "base": "int64" }, { "type": "reference", "id": "uom", "name": "Unit of measure", "comment": "Energy unit of measure; typical value is kWh for active energy,kVArh for reactive energy and kVAh for apparent energy.", "reference": "8000010500000000-4/unit_of_measure_t" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_energy_3ph { "class": "datapoint", "id": "UNVT_energy_3ph", "key": 2, "name": "Electric energy", "comment": "This datapoint reports electric energy for up to three phases", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "scalar", "id": "L1_energy", "name": "L1_energy", "comment": "Phase L1 (A) energy summation reading", "base": "int64" }, { "type": "scalar", "id": "L2_energy", "name": "L2_energy", "comment": "Phase L2 (B) energy summation reading", "base": "int64" }, { "type": "scalar", "id": "L3_energy", "name": "L3_energy", "comment": "Phase L3 (C) energy summation reading", "base": "int64" }, { "type": "reference", "id": "uom", "name": "Unit of measure", "comment": "Energy unit of measure; typical value in kWh for active energy, KVArh for reactive energy and KVAh for apparent energy.", "reference": "8000010500000000-4/unt_of_measure_t" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_power_3ph { "class": "datapoint", "id": "UNVT_power_3ph", "key": 4, "name": "Instantaneous power reading by phase", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "float", "id": "L1_net_power", "name": "L1_net_power", "comment": "Phase L1 (A) net power", "base": "float" }, { "type": "float", "id": "L2_net_power", "name": "L2_net_power", "comment": "Phase L2 (B) net power", "base": "float" }, { "type": "float", "id": "L3_net_power", "name": "L3_net_power", "comment": "Phase L3 (C) net power", "base": "float" }, { "type": "reference", "id": "uom", "name": "unit of measure", "comment": "Power unit of measure; typical value is kW for active power,kVAr for reactive power and kVA for apparent power", "reference": "8000010500000000-4/unit_of_measure_t" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_power_net { "class": "datapoint", "id": "UNVT_power_net", "key": 5, "name": "Instantaneous power reading values", "comment": "This datapoint reports instantaneous power readings for up to three phases", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "reference", "id": "net_active", "name": "Net active power", "comment": "Net active power; instantaneous or demand reading for returned net active power", "reference": "SNVT_power_f", "unit": "W" }, { "type": "reference", "id": "net_reactive", "name": "Net reactive power", "comment": "Net reactive power; instantaneous or demand reading for returned net reactive power", "reference": "SNVT_power_f", "unit": "Var" }, { "type": "reference", "id": "net_apparent", "name": "Net apparent power", "comment": "Net apparent power; instantaneous or demand reading for returned net apparent power", "reference": "SNVT_power_f", "unit": "VA" }, { "type": "boolean", "id": "phase_1_active", "name": "Phase L1(A) active" }, { "type": "boolean", "id": "phase_2_active", "name": "Phase L2(B) active" }, { "type": "boolean", "id": "phase_3_active", "name": "Phase L3(C) active" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_power_stat { "class": "datapoint", "id": "UNVT_power_stat", "key": 6, "name": "Power status", "comment": "This datapoint reports power status and quality for up to three phases", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "reference", "id": "average_power_factor", "name": "Average Power Factor", "comment": "Average Power Factor", "reference": "8000010500000000-4/UNVT_pwr_fact_q" }, { "type": "reference", "id": "L1_power_factor", "name": "L1 Power Factor", "comment": "Phase L1(A) Power Factor", "reference": "8000010500000000-4/UNVT_pwr_fact_q" }, { "type": "reference", "id": "L2_power_factor", "name": "L2 Power Factor", "comment": "Phase L2(B) Power Factor", "reference": "8000010500000000-4/UNVT_pwr_fact_q" }, { "type": "reference", "id": "L3_power_factor", "name": "L3 Power Factor", "comment": "Phase L3(C) Power Factor", "reference": "8000010500000000-4/UNVT_pwr_fact_q" }, { "type": "reference", "id": "current_thd", "name": "Current_THD", "comment": "RMS current Total harmonic Distorion", "reference": "SNVT_lev_percent" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_pwr_fact_q { "class": "datapoint", "id": "UNVT_pwr_fact_q", "key": 7, "name": "Power Factor with quadrant", "comment": "This datapoint reports power factor and quadrant for a single phase", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "reference", "id": "power_factor", "name": "Power Factor", "reference": "SNVT_pwr_fact_f" }, { "type": "reference", "id": "quadrant", "name": "Power Quadrant", "reference": "8000010500000000-4/power_quadrant_t", "comment": "Indicates Power quadrant" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_unique_id { "class": "datapoint", "id": "UNVT_unique_id", "key": 8, "name": "Unique ID", "comment": "A unique identifier, typically EUI-48 or EUI-64", "type": { "type": "scalar", "array_size": 8, "base": "uint8", "encoding": "hex" } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_voltage_3ph { "class": "datapoint", "id": "UNVT_voltage_3ph", "key": 9, "name": "Voltage", "comment": "Instantaneous voltage readings", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "reference", "id": "L1N_voltage", "name": "L1N Voltage", "comment": "Phase L1 (A) neutral voltage", "reference": "SNVT_volt_f" }, { "type": "reference", "id": "L2N_voltage", "name": "L2N Voltage", "comment": "Phase L2 (B) neutral voltage", "reference": "SNVT_volt_f" }, { "type": "reference", "id": "L3N_voltage", "name": "L3N Voltage", "comment": "Phase L3 (C) neutral voltage", "reference": "SNVT_volt_f" }, { "type": "reference", "id": "L1L2_voltage", "name": "L1L2 Voltage", "comment": "Phase L1 (A) to L2 (B) voltage", "reference": "SNVT_volt_f" }, { "type": "reference", "id": "L1L3_voltage", "name": "L1L3 Voltage", "comment": "Phase L1 (A) to L3 (C) voltage", "reference": "SNVT_volt_f" }, { "type": "reference", "id": "L2L3_voltage", "name": "L2L3 Voltage", "comment": "Phase L2 (B) to L3 (C) voltage", "reference": "SNVT_volt_f" }] } } glp/0/144/fb/res/type/8000010500000000-4/UNVT_voltage_avg { "class": "datapoint", "id": "UNVT_voltage_avg", "key": 9, "name": "Average Voltage", "comment": "Average voltage readings", "type": { "type": "aggregate", "cat": "allOf", "members": [{ "type": "reference", "id": "average_LL_voltage", "name": "Average L-L Voltage", "comment": "Average phase-to-phase voltage", "reference": "SNVT_volt_f" }, { "type": "reference", "id": "average_LN_voltage", "name": "Average L-N Voltage", "comment": "Average phase-to-neutral voltage", "reference": "SNVT_volt_f" }] } } glp/0/144/fb/res/type/8000010500000000-4/UCPTctRatio { "class": "property", "id": "UCPTctRatio", "key": 1, "name": "Current Transformation Ratio", "comment": "Current transformer ratio;the multiplier/divisor is used to scale a data reading when an external current transformer is used; set to the invalid value to disable scaling", "type": { "type": "reference", "reference": "SNVT_muldiv" }, "default": { "multiplier": 1, "divisor": 1 } } glp/0/144/fb/res/type/8000010500000000-4/UCPTdeviceId { "class": "property", "id": "UCPTdeviceId", "key": 2, "name": "Unique ID", "comment": "Unique Identifier for a device", "type": { "type": "reference", "reference": "8000010500000000-4/UNVT_unique_id" } } glp/0/144/fb/res/type/8000010500000000-4/UCPTphaseCount { "class": "property", "id": "UCPTphaseCount", "key": 3, "name": "Phase count", "comment": "number of connected phases", "type": { "type": "scalar", "min": 0, "max": 3, "base": "int8" }, "default": 3 } glp/0/144/fb/res/type/8000010500000000-4/unit_of_measure_t { "class": "enumeration", "id": "unit_of_measure_t", "key": 1, "name": "Unit of measure", "members": [{ "id": "UOM_NUL", "value": -1, "name": "invalid", "comment": "Invalid value; use if value not available or not specified" }, { "id": "UOM_OTHER", "value": 0, "name": "other", "comment": "Other commodity or measure" }, { "id": "UOM_ELEC_A", "value": 5, "name": "A", "comment": "Electric Ampere" }, { "id": "UOM_ELEC_HZ", "value": 6, "name": "Hz", "comment": "Electric Frequency in hertz" }, { "id": "UOM_ELEC_HZ_1", "value": 7, "name": "s", "comment": "Electric period in seconds (1/Hz)" }, { "id": "UOM_ELEC_J", "value": 8, "name": "J", "comment": "Electrical joule" }, { "id": "UOM_ELEC_KVA", "value": 9, "name": "KVA", "comment": "Electrical kilovolt-ampere" }, { "id": "UOM_ELEC_KVAH", "value": 10, "name": "KVAh", "comment": "Electrical kilovolt-ampere-hours" }, { "id": "UOM_ELEC_KVAR", "value": 11, "name": "Kvar", "comment": "Electrical reactive kilovolt-ampere" }, { "id": "UOM_ELEC_KVARH", "value": 12, "name": "Kvarh", "comment": "Electrical reactive kilovolt-ampere hours" }, { "id": "UOM_ELEC_KW", "value": 13, "name": "KW", "comment": "Electrical kiloWatt" }, { "id": "UOM_ELEC_KWH", "value": 14, "name": "KWh", "comment": "Electrical kilovolt-hour" }, { "id": "UOM_ELEC_V", "value": 15, "name": "V", "comment": "Electrical volt" }, { "id": "UOM_ELEC_V_VAR", "value": 16, "name": "Kvar", "comment": "Electrical Volt reactive" }, { "id": "UOM_ELEC_VA", "value": 17, "name": "VA", "comment": "Electrical volt-ampere" }, { "id": "UOM_ELEC_VAR", "value": 18, "name": "var", "comment": "Electrical volt-ampere reactive" }, { "id": "UOM_ELEC_KVARH", "value": 19, "name": "varh", "comment": "Electrical reactive volt-ampere hour" }, { "id": "UOM_ELEC_W", "value": 20, "name": "W", "comment": "Electrical Watt" }, { "id": "UOM_ELEC_W_HZ", "value": 21, "name": "Hz", "comment": "Electrical Watt/hertz" }, { "id": "UOM_ELEC_WS", "value": 22, "name": "Ws", "comment": "Electrical Watt second" }, { "id": "UOM_ELEC_WH", "value": 23, "name": "Wh", "comment": "Electrical Watt hour" }] } glp/0/144/fb/res/type/8000010500000000-4/UFPT3pSubMeter { "class": "profile", "id": "UFPT3pSubMeter", "key": 2000, "name": "Three Sub-meter profile", "principal": "nvoActiveEnergy", "datapoints": { "nvoActiveEnergy": { "id": "nvoActiveEnergy", "type": "8000010500000000-4/UNVT_energy_i64", "unit": "kWh", "dir": "output", "mandatory": true, "name": "Total present Active Energy", "comment": "This datapoint reports the total present active (real) energy" }, "nvoReactEnergy": { "id": "nvoReactEnergy", "type": "8000010500000000-4/UNVT_energy_i64", "unit": "Varh", "dir": "output", "mandatory": true, "name": "Total present Reactive Energy", "comment": "This datapoint reports the total present reactive energy" }, "nvoAppEnergy": { "id": "nvoAppEnergy", "type": "8000010500000000-4/UNVT_energy_i64", "unit": "VAh", "dir": "output", "mandatory": true, "name": "Total present Apparent Energy", "comment": "This datapoint reports the total present apparent energy" }, "nvoPhaseActEnergy": { "id": "nvoPhaseActEnergy", "type": "8000010500000000-4/UNVT_energy_3ph", "unit": "kWh", "dir": "output", "mandatory": true, "name": "Total present active Energy by phase", "comment": "This datapoint reports the total present active energy by phase" }, "nvoPhaseRctEnergy": { "id": "nvoPhaseRctEnergy", "type": "8000010500000000-4/UNVT_energy_3ph", "unit": "Varh", "dir": "output", "mandatory": true, "name": "Total present Reactive Energy by phase", "comment": "This datapoint reports the total present reactive energy by phase" }, "nvoPhaseAppEnergy": { "id": "nvoPhaseAppEnergy", "type": "8000010500000000-4/UNVT_energy_3ph", "unit": "Vah", "dir": "output", "mandatory": true, "name": "Total present apparent Energy by phase", "comment": "This datapoint reports the total present apparent energy by phase" }, "nvoPower": { "id": "nvoPower", "type": "8000010500000000-4/UNVT_power_net", "dir": "output", "mandatory": true, "name": "Total instantaneous power reading", "comment": "This datapoint reports the total instantaneous power reading" }, "nvoPhaseActPwr": { "id": "nvoPhaseActPwr", "type": "8000010500000000-4/UNVT_power_3ph", "dir": "output", "mandatory": true, "name": "Active power by phase", "comment": "This datapoint reports the instantaneous active power reading by phase" }, "nvoPhaseReactPwr": { "id": "nvoPhaseReactPwr", "type": "8000010500000000-4/UNVT_power_3ph", "dir": "output", "mandatory": true, "name": "Reactive power by phase", "comment": "This datapoint reports the instantaneous reactive power reading by phase" }, "nvoPhaseAppPwr": { "id": "nvoPhaseAppPwr", "type": "8000010500000000-4/UNVT_power_3ph", "dir": "output", "mandatory": true, "name": "Apparent power by phase", "comment": "This datapoint reports the instantaneous apparent power reading by phase" }, "nvoVoltageRMS": { "id": "nvoVoltageRMS", "type": "8000010500000000-4/UNVT_voltage_3ph", "dir": "output", "mandatory": true, "name": "RMS voltage", "comment": "This datapoint reports the RMS line-to-neutral and line-to-line voltage reading" }, "nvoVoltageAvg": { "id": "nvoVoltageAvg", "type": "8000010500000000-4/UNVT_voltage_avg", "dir": "output", "mandatory": true, "name": "Average voltage", "comment": "This datapoint reports the average line-to-neutral and line-to-line voltage" }, "nvoCurrentRMS": { "id": "nvoCurrentRMS", "type": "8000010500000000-4/UNVT_current_3ph", "dir": "output", "mandatory": true, "name": "RMS Current bu phase", "comment": "This datapoint reports the RMS current by phase" }, "nvoPowerStatus": { "id": "nvoPowerStatus", "type": "8000010500000000-4/UNVT_power_stat", "dir": "output", "mandatory": true, "name": "Power Status", "comment": "This datapoint reports the power status and quality" } }, "properties": { "cpMeterId": { "id": "cpMeterId", "type": "8000010500000000-4/UCPTdeviceId", "mandatory": true, "name": "Meter identifier", "comment": "This property reports the identifier of the meter", "applies": "UFPT3pSubMeter" }, "cpMeterModel": { "id": "cpMeterModel", "type": "SCPTpartNumber", "mandatory": true, "name": "Meter model number", "comment": "This property reports the meter model number", "applies": "UFPT3pSubMeter" }, "cpSerialNumber": { "id": "cpSerialNumber", "type": "SCPTserialNumber", "mandatory": true, "name": "Meter serial number", "comment": "This property reports the meter serial number", "applies": "UFPT3pSubMeter" }, "cpPhaseCount": { "id": "cpPhaseCount", "type": "8000010500000000-4/UCPTphaseCount", "mandatory": true, "name": "Number of phases", "comment": "This property reports number of connected phases", "applies": "UFPT3pSubMeter" }, "cpObjMajVer": { "id": "cpObjMajVer", "type": "SCPTobjMajVer", "mandatory": true, "name": "profile implementation major version number", "comment": "this property reports the profile implementation major version number", "applies": "UFPT3pSubMeter" }, "cpObjMinVer": { "id": "cpObjMinVer", "type": "SCPTobjMinVer", "mandatory": true, "name": "profile implementation minor version number", "comment": "this property reports the profile implementation minor version number", "applies": "UFPT3pSubMeter" }, "cpCtRatio": { "id": "cpCtRatio", "type": "8000010500000000-4/UCPTctRatio", "mandatory": true, "name": "Current transformer ratio", "comment": "This datapoint reports the current transformer ratio;the multiplier/divisor used to scale the current readings when an external current transformer is used (ST15);set to the invalid value to disable scaling.", "applies": "UFPT3pSubMeter" }, "cpVtRatio": { "id": "cpVtRatio", "type": "8000010500000000-4/UCPTctRatio", "mandatory": true, "name": "Voltage transformer ratio", "comment": "This datapoint reports the voltage transformer ratio;the multiplier/divisor used to scale the voltage readings when an external voltage transformer is used (ST15);set to the invalid value to disable scaling.", "applies": "UFPT3pSubMeter" } } } glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0 { "desc": "Three Phase Sunb-meter profile", "type": "8000010500000000-4/UFPT3pSubMeter", "nvoVoltageRMS": { "desc": "RMS Voltage", "type": "8000010500000000-4/UNVT_voltage_3ph", "property": false, "cat": "out", "value": { "L1N_voltage": 0.0181, "L2N_voltage": 0.0181, "L3N_voltage": 0.0181 }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoVoltageAvg": { "desc": "Average Voltage", "type": "8000010500000000-4/UNVT_voltage_avg", "property": false, "cat": "out", "value": { "average_LN_voltage": 0.0181, "average_LL_voltage": "invalid" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoActiveEnergy": { "desc": "Total present Active Energy", "type": "8000010500000000-4/UNVT_energy_i64", "property": false, "cat": "out", "value": { "total": 0, "uom": "UOM_ELEC_WH" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoReactEnergy": { "desc": "Total present Reactive Energy", "type": "8000010500000000-4/UNVT_energy_i64", "property": false, "cat": "out", "value": { "total": 0, "uom": "UOM_ELEC_KVARH" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoAppEnergy": { "desc": "Total present Apparent Energy", "type": "8000010500000000-4/UNVT_energy_i64", "property": false, "cat": "out", "value": { "total": 0, "uom": "UOM_ELEC_VAH" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPower": { "desc": "Total instantaneous power reading", "type": "8000010500000000-4/UNVT_power_net", "property": false, "cat": "out", "value": { "net_active": 0.0003, "net_reactive": 0, "net_apparent": 0, "phase_1_active": true, "phase_2_active": true, "phase_3_active": true }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPowerStatus": { "desc": "Power Status", "type": "8000010500000000-4/UNVT_power_stat", "property": false, "cat": "out", "value": { "average_power_factor": { "power_factor": 0, "quadrant": "invalid" }, "L1_power_factor": { "power_factor": -0.0010, "quadrant": "invalid" }, "L2_power_factor": { "power_factor": -0.0010, "quadrant": "invalid" }, "L3_power_factor": { "power_factor": -1, "quadrant": "invalid" }, "Current_thd": "invalid" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "cpMeterId": { "desc": "Meter identifier", "type": "8000010500000000-4/UCPTdeviceId", "property": true, "cat": "out", "value": "ABCD1234" }, "cpMeterModel": { "desc": "Meter Model Number", "type": "SCPTpartNumber", "property": true, "cat": "out", "value": "12345" }, "cpSerialNumber": { "desc": "Meter Serial Number", "type": "SCPTserialNumber", "property": true, "cat": "out", "value": "123456" }, "cpPhaseCount": { "desc": "Number of phases", "type": "8000010500000000-4/UCPTphaseCount", "property": true, "cat": "out", "value": 3 }, "cpObjMajVer": { "desc": "implementation major version number", "type": "SCPTobjMajVer", "property": true, "cat": "out", "value": "1" }, "cpObjMinVer": { "desc": "implementation minor version number", "type": "SCPTobjMinVer", "property": true, "cat": "out", "value": "1" }, "cpCtRatio": { "desc": "Current transformation ratio", "type": "8000010500000000-4/UCPTctRatio", "property": true, "cat": "out", "value": { "multiplier": 0, "divisor": 0 } }, "nvoCurrentRMS": { "desc": "RMS Current by Phase", "type": "8000010500000000-4/UNVT_current_3ph", "property": false, "cat": "out", "value": { "L1_current": 0.0018, "L2_current": 0.0018, "L3_current": 0.0018, "average_current": 0.0018, "neutral_current": 0.0018 }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPhaseActEnergy": { "desc": "Present active energy by phase", "type": "8000010500000000-4/UNVT_energy_3ph", "property": false, "cat": "out", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_WH" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPhaseRctEnergy": { "desc": "Present reactive energy by phase", "type": "8000010500000000-4/UNVT_energy_3ph", "property": false, "cat": "out", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_VARH" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPhaseAppEnergy": { "desc": "Present apparent energy by phase", "type": "8000010500000000-4/UNVT_energy_3ph", "property": false, "cat": "out", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_VAH" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPhaseActPwr": { "desc": "Active power by phase", "type": "8000010500000000-4/UNVT_power_3ph", "property": false, "cat": "out", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0.0003, "uom": "UOM_ElEC_KW" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPhaseReactPwr": { "desc": "Reactive power by phase", "type": "8000010500000000-4/UNVT_power_3ph", "property": false, "cat": "out", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0.0003, "uom": "UOM_ElEC_KVAR" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "nvoPhaseAppPwr": { "desc": "Apparent power by phase", "type": "8000010500000000-4/UNVT_power_3ph", "property": false, "cat": "out", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0, "uom": "UOM_ElEC_KVA" }, "monitor": { "rate": 0, "cat": "", "inFeedback": false, "report": "", "throttle": 0, "threshold": 0 } }, "mru": "2018-07-12 11:58:44.170 UTC" } glp/0/144/fb/dev/iox.409eb1/meter/sts { "state": "provisioned", "unid": "257", "health": "normal", "cat": "metering", "type": "meter", "interfaceType": "static", "usage": "mixed", "version": "1.0.0" }
2. Request for monitoring configuration
To get the monitoring configuration from metering device publish the message on the topic "glp/0/SID/rq/dev/IOX_HANDLE/meter/if/phase/0".
IOX will send the response to Apollo on feedback channel as well as publishes configuration data to monitoring service.
glp/0/144/rq/dev/iox.409eb1/meter/if/phase/0 { "nvoVoltageRMS": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":21, "threshold":31 } }, "nvoVoltageAvg": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":21, "threshold":31 } }, "nvoCurrentRMS": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoActiveEnergy": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoReactEnergy": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoAppEnergy": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPhaseActEnergy": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPhaseRctEnergy": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPhaseAppEnergy": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPower": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPhaseActPwr": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPhaseReactPwr": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPhaseAppPwr": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } }, "nvoPowerStatus": { "monitor": { "rate":50, "cat":"data", "inFeedback":false, "report":"change", "throttle":22, "threshold":32 } } }
3. Response from IOX to Apollo on feedback channel for metering data
glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0 { "desc": "Three Phase Sunb-meter profile", "type": "8000010500000000-4/UFPT3pSubMeter", "nvoVoltageRMS": { "desc": "RMS Voltage", "type": "8000010500000000-4/UNVT_voltage_3ph", "property": false, "cat": "out", "value": { "L1N_voltage": 0.0181, "L2N_voltage": 0.0181, "L3N_voltage": 0.0181 }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 21, "threshold": 31 } }, "nvoVoltageAvg": { "desc": "Average Voltage", "type": "8000010500000000-4/UNVT_voltage_avg", "property": false, "cat": "out", "value": { "average_LN_voltage": 0.0181, "average_LL_voltage": "invalid" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 21, "threshold": 31 } }, "nvoActiveEnergy": { "desc": "Total present Active Energy", "type": "8000010500000000-4/UNVT_energy_i64", "property": false, "cat": "out", "value": { "total": 0, "uom": "UOM_ELEC_WH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoReactEnergy": { "desc": "Total present Reactive Energy", "type": "8000010500000000-4/UNVT_energy_i64", "property": false, "cat": "out", "value": { "total": 0, "uom": "UOM_ELEC_KVARH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoAppEnergy": { "desc": "Total present Apparent Energy", "type": "8000010500000000-4/UNVT_energy_i64", "property": false, "cat": "out", "value": { "total": 0, "uom": "UOM_ELEC_VAH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPower": { "desc": "Total instantaneous power reading", "type": "8000010500000000-4/UNVT_power_net", "property": false, "cat": "out", "value": { "net_active": 0.0003, "net_reactive": 0, "net_apparent": 0, "phase_1_active": true, "phase_2_active": true, "phase_3_active": true }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPowerStatus": { "desc": "Power Status", "type": "8000010500000000-4/UNVT_power_stat", "property": false, "cat": "out", "value": { "average_power_factor": { "power_factor": 0, "quadrant": "invalid" }, "L1_power_factor": { "power_factor": -0.0010, "quadrant": "invalid" }, "L2_power_factor": { "power_factor": -0.0010, "quadrant": "invalid" }, "L3_power_factor": { "power_factor": -1, "quadrant": "invalid" }, "Current_thd": "invalid" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "cpMeterId": { "desc": "Meter identifier", "type": "8000010500000000-4/UCPTdeviceId", "property": true, "cat": "out", "value": "ABCD1234" }, "cpMeterModel": { "desc": "Meter Model Number", "type": "SCPTpartNumber", "property": true, "cat": "out", "value": "12345" }, "cpSerialNumber": { "desc": "Meter Serial Number", "type": "SCPTserialNumber", "property": true, "cat": "out", "value": "123456" }, "cpPhaseCount": { "desc": "Number of phases", "type": "8000010500000000-4/UCPTphaseCount", "property": true, "cat": "out", "value": 3 }, "cpObjMajVer": { "desc": "implementation major version number", "type": "SCPTobjMajVer", "property": true, "cat": "out", "value": "1" }, "cpObjMinVer": { "desc": "implementation minor version number", "type": "SCPTobjMinVer", "property": true, "cat": "out", "value": "1" }, "cpCtRatio": { "desc": "Current transformation ratio", "type": "8000010500000000-4/UCPTctRatio", "property": true, "cat": "out", "value": { "multiplier": 0, "divisor": 0 } }, "nvoCurrentRMS": { "desc": "RMS Current by Phase", "type": "8000010500000000-4/UNVT_current_3ph", "property": false, "cat": "out", "value": { "L1_current": 0.0018, "L2_current": 0.0018, "L3_current": 0.0018, "average_current": 0.0018, "neutral_current": 0.0018 }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPhaseActEnergy": { "desc": "Present active energy by phase", "type": "8000010500000000-4/UNVT_energy_3ph", "property": false, "cat": "out", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_WH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPhaseRctEnergy": { "desc": "Present reactive energy by phase", "type": "8000010500000000-4/UNVT_energy_3ph", "property": false, "cat": "out", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_VARH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPhaseAppEnergy": { "desc": "Present apparent energy by phase", "type": "8000010500000000-4/UNVT_energy_3ph", "property": false, "cat": "out", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_VAH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPhaseActPwr": { "desc": "Active power by phase", "type": "8000010500000000-4/UNVT_power_3ph", "property": false, "cat": "out", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0.0003, "uom": "UOM_ElEC_KW" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPhaseReactPwr": { "desc": "Reactive power by phase", "type": "8000010500000000-4/UNVT_power_3ph", "property": false, "cat": "out", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0.0003, "uom": "UOM_ElEC_KVAR" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "nvoPhaseAppPwr": { "desc": "Apparent power by phase", "type": "8000010500000000-4/UNVT_power_3ph", "property": false, "cat": "out", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0, "uom": "UOM_ElEC_KVA" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 } }, "mru": "2018-07-12 12:00:45.830 UTC" }
4. Response from IOX to monitoring service
glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoVoltageRMS", "value": { "L1N_voltage": 0.0181, "L2N_voltage": 0.0181, "L3N_voltage": 0.0181 }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 21, "threshold": 31 }, "mru": "2018-07-12 12:01:36.150 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoCurrentRMS", "value": { "L1_current": 0.0018, "L2_current": 0.0018, "L3_current": 0.0018, "average_current": 0.0018, "neutral_current": 0.0018 }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:36.240 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPhaseActPwr", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0.0003, "uom": "UOM_ElEC_KW" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:36.410 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPhaseReactPwr", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0.0003, "uom": "UOM_ElEC_KVAR" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:36.620 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPhaseAppPwr", "value": { "L1_net_power": 0, "L2_net_power": 0, "L3_net_power": 0, "uom": "UOM_ElEC_KVA" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:36.860 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPhaseActEnergy", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_WH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:37.110 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPhaseRctEnergy", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_VARH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:37.360 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPhaseAppEnergy", "value": { "L1_energy": 0, "L2_energy": 0, "L3_energy": 0, "uom": "UOM_ElEC_VAR" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:37.610 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoActiveEnergy", "value": { "total": 0, "uom": "UOM_ELEC_WH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:37.860 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoReactEnergy", "value": { "total": 0, "uom": "UOM_ELEC_KVARH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:38.110 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoAppEnergy", "value": { "total": 0, "uom": "UOM_ELEC_VAH" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:38.350 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoVoltageAvg", "value": { "average_LN_voltage": 0.0181, "average_LL_voltage": "invalid" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 21, "threshold": 31 }, "mru": "2018-07-12 12:01:38.600 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPowerStatus", "value": { "average_power_factor": { "power_factor": 0, "quadrant": "invalid" }, "L1_power_factor": { "power_factor": -0.0010, "quadrant": "invalid" }, "L2_power_factor": { "power_factor": -0.0010, "quadrant": "invalid" }, "L3_power_factor": { "power_factor": -1, "quadrant": "invalid" }, "Current_thd": "invalid" }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:38.850 UTC" } glp/0/./=monitoring/service { "topic": "glp/0/144/fb/dev/iox.409eb1/meter/if/phase/0", "datapoint": "nvoPower", "value": { "net_active": 0, "net_reactive": 0, "net_apparent": 0, "phase_1_active": true, "phase_2_active": true, "phase_3_active": true }, "monitor": { "rate": 50, "cat": "data", "inFeedback": false, "report": "change", "throttle": 22, "threshold": 32 }, "mru": "2018-07-12 12:01:39.130 UTC" }
5. Metering device deprovisioning
mosquitto_pub -t glp/0/wq72/rq/dev/iox.409e21/meter/do -m '{ "action":"deprovision" }'