Skip to content

Latest commit

 

History

History
408 lines (287 loc) · 21 KB

EDT-02.md

File metadata and controls

408 lines (287 loc) · 21 KB
Raw

The EDT object specification for the node-echonet-lite

Housing/Facilities-related Device Class Group

  • Class group code: 0x02

The node-echonet-lite module support the classes in this class group as follows:

Low-voltage smart electric energy meter class

  • Class group code: 0x02
  • Class code: 0x88

Operation status

  • EPC: 0x80
Property Type Description
status Boolean This property indicates the ON/OFF status. If the status is "ON", this value is true. Otherwise, if it is "OFF", this value is false.

Coefficient

  • EPC: 0xD3
Property Type Description
coefficient Number This property indicates the coefficient for converting measured cumulative amount of electric energy and historical data to actual usage amount.

The value of the coefficient must be an integer in the range of 0 to 999999.

Number of effective digits for cumulative amounts of electric energy

  • EPC: 0xD7
Property Type Description
digit Number This property indicates the number of effective digits for measured cumulative amounts of electric energy.

The value of the digit must be an integer in the range of 1 to 8.

Measured cumulative amount of electric energy (normal direction)

  • EPC: 0xE0
Property Type Description
energy Number This property indicates the measured cumulative amount of electric energy in units of "kWh".

The value of the energy must be an integer in the range of 0 to 99999999.

Unit for cumulative amounts of electric energy (normal and reverse directions)

  • EPC: 0xE1
Property Type Description
unit Number This property indicates the unit (multiplying factor) used for the measured cumulative amount of electric energy and the historical data of measured cumulative amounts of electric energy. This value is a float number such as 1, 0.1, 0.01, 10, 100, etc.

The value of the unit must be an float which is either 1.0, 0.1, 0.01, 0.001, 0.0001, 10, 100, 1000, or 10000 (kWh).

Historical data of measured cumulative amounts of electric energy 1 (normal direction)

  • EPC: 0xE2
Property Type Description
day Number This property indicates the day for which the historical data of measured cumulative amounts of electric energy is to be retrieved.
history Array This property indicates the historical data of measured cumulative amounts of electric energy (normal direction), which consists of 48 items of half-hourly data for the preceding 24 hours (00:00 to 23:30) of the day by time series. This value is an Array object.

The value of the day property must be an integer in the range of 0 to 99.

The value of the history must be an Array object. The number of the elements in the Array object must be equal to or less than 48. Each element in the Array must be an integer in the range of 0 to 99999999.

Note that each element in the Array is meaningless by itself. In order to know the meaningful value, the coefficient (the EPC is 0xD3) and the unit (the EPC is 0xE1) are essential. If the targeted device doesn't support the unit (the EPC is 0xE1), then the unit must be assumed to be 1 kWh.

Measured cumulative amounts of electric energy (reverse direction)

  • EPC: 0xE3
Property Type Description
energy Number This property indicates the measured cumulative amounts of electric energy in units of "kWh".

The value of the energy must be an integer in the range of 0 to 99999999.

Historical data of measured cumulative amounts of electric energy 1 (reverse direction)

  • EPC: 0xE4
Property Type Description
day Number This property indicates the day for which the historical data of measured cumulative amounts of electric energy is to be retrieved.
history Array This property indicates the historical data of measured cumulative amounts of electric energy ((reverse direction), which consists of 48 items of half-hourly data for the preceding 24 hours (00:00 to 23:30) of the day by time series. This value is an Array object.

The value of the day property must be an integer in the range of 0 to 99.

The value of the history must be an Array object. The number of the elements in the Array object must be equal to or less than 48. Each element in the Array must be an integer in the range of 0 to 99999999.

Note that each element in the Array is meaningless by itself. In order to know the meaningful value, the coefficient (the EPC is 0xD3) and the unit (the EPC is 0xE1) are essential. If the targeted device doesn't support the unit (the EPC is 0xE1), then the unit must be assumed to be 1 kWh.

Day for which the historical data of measured cumulative amounts of electric energy is to be retrieved 1

  • EPC: 0xE5
Property Type Description
day Number This property indicates the day for which the historical data of measured cumulative amounts of electric energy (which consists of 48 items of half-hourly data for the preceding 24 hours) is to be retrieved.

The value of the day must be an integer in the range of 0 to 99.

Measured instantaneous electric energy

  • EPC: 0xE7
Property Type Description
energy Number This property indicates the measured effective instantaneous electric energy in 1W unit.

The value of the energy must be an integer in the range of -2147483647 to 2147483645.

Measured instantaneous currents

  • EPC: 0xE8
Property Type Description
r Number This property indicates the measured effective instantaneous R phase currents in 1A unit.
t Number This property indicates the measured effective instantaneous T phase currents in 1A unit.

The value of the r and t must be an integer in the range of -3276.7 to 3276.5. If the targeted smarter meter is a single-phase, two-wire system, the value of the t property will be 3276.6.

Cumulative amounts of electric energy measured at fixed time (normal direction)

  • EPC: 0xEA

This property indicates the most recent cumulative amount of electric energy (normal direction) measured at 30-minute intervals held by the meter. This EDT includes the date of measurement, time of measurement, and the cumulative electric energy (normal direction).

Property Type Description
date String This property indicates the date of measurement in form of "YYYY-MM-DD".
time String This property indicates the time of measurement in form of "HH:MM:SS".
energy Number This property indicates the cumulative electric energy (normal direction)

The value of the energy must be an integer in the range of 0 to 99999999.

Note that the value of the energy property is meaningless by itself. In order to know the meaningful value, the coefficient (the EPC is 0xD3) and the unit (the EPC is 0xE1) are essential. If the targeted device doesn't support the unit (the EPC is 0xE1), then the unit must be assumed to be 1 kWh.

If the value of energy is 0xFFFFFFFE, it means there is no measurement value at the time.

Cumulative amounts of electric energy measured at fixed time (reverse direction)

  • EPC: 0xEB

This property indicates the most recent cumulative amount of electric energy (reverse direction) measured at 30-minute intervals held by the meter. This EDT includes the date of measurement, time of measurement, and the cumulative electric energy (reverse direction).

Property Type Description
date String This property indicates the date of measurement in form of "YYYY-MM-DD".
time String This property indicates the time of measurement in form of "HH:MM:SS".
energy Number This property indicates the cumulative electric energy (reverse direction)

The value of the energy must be an integer in the range of 0 to 99999999.

Note that the value of the energy property is meaningless by itself. In order to know the meaningful value, the coefficient (the EPC is 0xD3) and the unit (the EPC is 0xE1) are essential. If the targeted device doesn't support the unit (the EPC is 0xE1), then the unit must be assumed to be 1 kWh.

If the value of energy is 0xFFFFFFFE, it means there is no measurement value at the time.

Historical data of measured cumulative amounts of electric energy 2 (normal and reverse directions)

  • EPC: 0xEC

This property indicates the historical data of measured cumulative amounts of electric energy every 30 minutes in the normal and reverse directions within the past six hours. This EDT includes the date and time for which the historical data of measured cumulative amounts of electric energy is to be retrieved, the number of the collection, and the cumulative amount of electric energy.

Property Type Description
date String This property indicates the date of measurement in form of "YYYY-MM-DD".
time String This property indicates the time of measurement in form of "HH:MM".
number Number This property indicates the number of the collection.
normal Array This property indicates the historical data of measured cumulative amounts of electric energy every 30 minutes in the normal direction within the past six hours as an Array object.
reverse Array This property indicates the historical data of measured cumulative amounts of electric energy every 30 minutes in the reverse direction within the past six hours as an Array object.

The value of the number property must be an integer in the range of 1 to 12.

The value of the normal and the reverse property must be an Array object. The number of the elements in the Array object must be equal to the value of the number property. Each element in the Array must be an integer in the range of 0 to 99999999.

Note that each element in the Array is meaningless by itself. In order to know the meaningful value, the coefficient (the EPC is 0xD3) and the unit (the EPC is 0xE1) are essential. If the targeted device doesn't support the unit (the EPC is 0xE1), then the unit must be assumed to be 1 kWh.

Cumulative amounts of electric energy measured at fixed time (reverse direction)

  • EPC: 0xED

This property indicates the date and time of historical data of measurements (every 30 minutes) and the number of segments where measurement historical data is collected every 30 minutes.

Property Type Description
date String This property indicates the date of measurement in form of "YYYY-MM-DD".
time String This property indicates the time of measurement in form of "HH:MM".
number Number This property indicates the number of segments.

The value of the number property must be an integer in the range of 1 to 12.

When you read this EDT object, if both the date and the time is an empty string and the value of the number property is 1, it means that the date and time for this EDT have not been set yet. If you want to create such an EDT object, specify an empty hash object (i.e. {}) as an EDT object.

General lighting class

  • Class group code: 0x02
  • Class code: 0x90

Operation status

  • EPC: 0x80
Property Type Description
status Boolean This property indicates the ON/OFF status. If the status is "ON", this value is true. Otherwise, if it is "OFF", this value is false.

Illuminance level

  • EPC: 0xB0
Property Type Description
level Number This property indicates illuminance level in %. When setting, this value must be an integer between 0 and 100.

Light color setting

  • EPC: 0xB1
Property Type Description
color Number This property indicates the color setting.

The color must be 0x40, 0x41, 0x42, 0x43, or 0x44. The code map is as follows. Each code is shown as hexadecimal representation:

Code Description (English) Description (Japanese)
0x40 Other その他
0x41 Incandescent lamp color 電球色
0x42 White 白色
0x43 Daylight white 昼白色
0x44 Daylight color 昼光色

Illuminance level step setting

  • EPC: 0xB2
Property Type Description
step Number Used to specify the illuminance level in terms of steps and acquire the current setting. When settig, this value must be an integer between 0x01 and the maximum specifiable illuminance level value (dark to bright).

Light color step setting

  • EPC: 0xB3
Property Type Description
step Number Used to specify the light color in terms of steps and acquire the current setting. When settig, this value must be an integer between 0x01 and the maximum specifiable light color value (incandescent lamp color to white).

Maximum specifiable values

  • EPC: 0xB4
Property Type Description
illuminance Number The maximum specifiable illuminance level value of main lighting.
color Number The maxinum specifiable light color value of main lighting.

Maximum value of settable level for night lighting

  • EPC: 0xB5
Property Type Description
illuminance Number The maximum values of illuminance for night lighting.
color Number light color settable levels for night lighting.

Lighting mode setting

  • EPC: 0xB6
Property Type Description
mode Number This property indicates the lighting mode setting.

The mode must be 0x41, 0x42, 0x43, or 0x45. The code map is as follows. Each code is shown as hexadecimal representation:

Code Description (English) Description (Japanese)
0x41 Auto 自動
0x42 Main lighting 通常灯
0x43 Night lighting 常夜灯
0x45 Color lighting カラー灯

Illuminance level setting for main lighting

  • EPC: 0xB7
Property Type Description
level Number This property indicates the illuminance level of main lighting in %. When setting, this value must be an integer between 0 and 100.

Illuminance level step setting for main lighting

  • EPC: 0xB8
Property Type Description
step Number Used to set the illuminance level by the number of steps for main lighting and to acquire the current setting. When settig, this value must be an integer between 0x01 and the maximum value of settable illuminance level(dark to bright).

Illuminance level setting for night lighting

  • EPC: 0xB9
Property Type Description
level Number This property indicates the illuminance level of night lighting in %. When setting, this value must be an integer between 0 and 100.

Illuminance level step setting for night lighting

  • EPC: 0xBA
Property Type Description
step Number Used to set the illuminance level by the number of steps for night lighting and to acquire the current setting status. When settig, this value must be an integer between 0x01 and the maximum value of settable illuminance level (dark to bright).

Light color setting for main lighting

  • EPC: 0xBB
Property Type Description
color Number This property is used to set the light color for main lighting.

The mode must be 0x40, 0x41, 0x42, 0x43, or 0x44. The code map is as follows. Each code is shown as hexadecimal representation:

Code Description (English) Description (Japanese)
0x40 Other その他
0x41 Incandescent lamp color 電球色
0x42 White 白色
0x43 Daylight white 昼白色
0x44 Daylight color 昼光色

Light color level step setting for main lighting

  • EPC: 0xBC
Property Type Description
step Number Used to set the light color level by the number of steps for main lighting and to acquire the current setting. When settig, this value must be an integer between 0x01 and the maximum value of settable light color level (incandescent lamp color to white).

Light color setting for night lighting

  • EPC: 0xBD
Property Type Description
color Number This property is used to set the light color for night lighting.

The mode must be 0x40, 0x41, 0x42, 0x43, or 0x44. The code map is as follows. Each code is shown as hexadecimal representation:

Code Description (English) Description (Japanese)
0x40 Other その他
0x41 Incandescent lamp color 電球色
0x42 White 白色
0x43 Daylight white 昼白色
0x44 Daylight color 昼光色

Light color level step setting for night lighting

  • EPC: 0xBE
Property Type Description
step Number Used to set the light color level by the number of steps for night lighting and to acquire the current setting.. When settig, this value must be an integer between 0x01 and the maximum value of settable light color level (incandescent lamp color to white).

Lighting mode status in auto mode

  • EPC: 0xBF
Property Type Description
mode Number This property is Used to acquire the current lighting mode in auto mode.

The mode must be 0x42, 0x43, 0x44, or 0x45. The code map is as follows. Each code is shown as hexadecimal representation:

Code Description (English) Description (Japanese)
0x42 Main lighting 通常灯
0x43 Night lighting 常夜灯
0x44 Off 消灯
0x45 Color lighting カラー灯

RGB setting for color lighting

  • EPC: 0xC0

This property is used to set the RGB value for color lighting and to acquire the current setting.

Property Type Description
r Number R compornent. When setting, this value must be an integer between 0 and 255.
g Number G compornent. When setting, this value must be an integer between 0 and 255.
b Number B compornent. When setting, this value must be an integer between 0 and 255.

ON timer reservation setting

  • EPC: 0x90
Property Type Description
set Boolean This property indicates the ON/OFF status of the ON timer reservation setting. If the status is "ON", this value is true. Otherwise, if it is "OFF", this value is false.

ON timer setting

  • EPC: 0x91
Property Type Description
h Number Hour. When setting, this value must be an integer between 0 and 23.
m Number Minute. When setting, this value must be an integer between 0 and 59.

OFF timer reservation setting

  • EPC: 0x94
Property Type Description
set Boolean This property indicates the ON/OFF status of the OFF timer reservation setting. If the status is "ON", this value is true. Otherwise, if it is "OFF", this value is false.

OFF timer setting

  • EPC: 0x95
Property Type Description
h Number Hour. When setting, this value must be an integer between 0 and 23.
m Number Minute. When setting, this value must be an integer between 0 and 59.