English
English
简体中文
Contact Us
Register
Log In
layoutIndex

Standard Instruction Set

Last Updated on : 2022-01-13 06:21:52download

This topic describes the standard instruction set of smart electricity meters (zndb).

Code Name Type Description
forward_energy_total Forward total active electricity Integer { “unit”: “kW·h”, “min”: 0, “max”:
99999999, “scale”: 2, “step”: 1 }
reverse_energy_total Reverse total active electricity Integer { “unit”: “kW·h”, “min”: 0, “max”:
99999999, “scale”: 2, “step”: 1 }
alarm_set_2 Alarm settings Json {}
charge_energy Topup Integer {“unit”:“kW·h”,“min”:0,“max”:5000,
“scale”:0,“step”:1}
clear_energy Clearing of the reading Boolean {}
event_clear Clearing of events Boolean {}
energy_daily Daily electricity consumption data Json {}
frozen_time_set Freezing time settings Json {}
energy_month Monthly electricity consumption data Json {}
switch Switch Boolean {}
switch_prepayment Prepaid function switch Boolean {}

Examples of standard instructions

energy_month

Display the monthly electricity consumption.

  • Description

    • startYear: the year when the statistics starts, in integer type.
    • startMonth: the month when the statistics starts, in integer type.
    • endYear: the year when the statistics ends, in integer type.
    • endMonth: the month when the statistics ends, in integer type.
  • Code example
    Get the total electricity consumption from December 2020 to January 2021.

    { "code": "energy_month", "value": "{\"startYear\":20,\"startMonth\":12,\"endYear\":21,\"endMonth\":1}" }

energy_daily

Display the daily electricity consumption.

  • Description

    • startMonth: the month when the statistics starts, in integer type.
    • startDay: the day when the statistics starts, in integer type.
    • endMonth: the month when the statistics ends, in integer type.
    • endDay: the day when the statistics ends, in integer type.
  • Code example
    Get the total electricity consumption from January 31 to February 15.

    { "code": "energy_daily", "value": "{\"startMonth\":1,\"startDay\":31,\"endMonth\":2,\"endDay\":15}" }

frozen_time_set

Set the monthly and daily freezing time of the electricity meter. The freezing time is the time for the meter to automatically record the current meter information.

  • Description

    • day: monthly freezing time. The value is an integer. Valid values: 1 to 28. Default value: 1.
    • hour: daily freezing time. The value is an integer. Valid values: 0 to 23. Default value: 0.
  • Code example
    Record the meter information at 23:00 on the 28th of each month.

    { "code": "frozen_time", "value": "{\"day\":28,\"hour\":23}" }

alarm_set_2

Set the alarm of the electricity meter.

  • Description

    • alarmCode: alarm type, [“overcurrent”,“three_phase_current_imbalance”,“ammeter_overvoltage”,
      “under_voltage”,“three_phase_current_loss”,“power_failure”,“magnetic”,“insufficient_balance”,
      “arrears”,“battery_overvoltage”,“cover_open”,“meter_cover_open”,“fault”].
    • doAction: Boolean type.
      • true: switch off the meter when an alarm is triggered.
      • false: do not switch off the meter when an alarm is triggered.
    • threshold: the threshold that is supported by specific alarm types.
  • alarmCode parameter description

    • overcurrent: overcurrent alarm. The value is an integer. Valid values: 10A to 100A. Default value: 60A.
    • three_phase_current_imbalance: the alarm of imbalanced three-phase current. The value is an integer. Valid values: 10% to 100%. Default value: 10%.
    • ammeter_overvoltage: overvoltage alarm. The value is an integer. Valid values: 100V to 270V. Default value: 245V.
    • under_voltage: under-voltage alarm. The value is an integer. Valid values: 90V to 250V. Default value: 180V.
    • three_phase_current_loss: the alarm of three-phase phase loss.
    • power_failure: the alarm of a power failure event. A power fault that is followed by powering on is regarded as an event.
    • magnetic: magnetic influence alarm.
    • insufficient_balance: insufficient balance alarm. The value is an integer. Valid values: 10 kWh to 500 kWh. Default value: 30 kWh.
    • arrears: the alarm of an outstanding payment.
    • battery_overvoltage: battery under-voltage alarm. Valid values: 2V to 10V. Default value: 3.30V. The value is rounded to two decimal places.
    • cover_open: An alarm is triggered when the end cover is opened.
    • meter_cover_open: An alarm is triggered when the meter cover is opened.
    • fault: the alarm of a meter hardware fault. For example, a fault might occur in the storage, relay, or real-time clock (RTC).
  • Code example
    The meter supports overcurrent alarms, magnetic influence alarms, and battery under-voltage alarms. If the current is higher than 11A, an alarm is triggered and the switch is opened. The switch will not be opened in case of a magnetic influence alarm. If the battery voltage is lower than 2.10V, an alarm is triggered and the switch is opened.

    { "code":"alarm_set_2", "value":"[{\"alarmCode\":\"overcurrent\",\"doAction\":true,\"threshold\":\"11\"},{\"alarmCode\":\"magnetic\",\"doAction\":false},{\"alarmCode\":\"battery_overvoltage\",\"doAction\":false,\"threshold\":\"2.10\"}]" }