Global

Type Definitions

advancedStatus

Properties:
Name Type Attributes Description
tm number

time of retrieving info. unix-time-format. e.g. 1542575626
net number

total energy counter, consumption - production
pwr number

power consumption in Watt. e.g. 3030
ts0 number <optional>

time of the last S0 measurement. unix-time-format. e.g. 1542575626 NOTE: only for LS120 ^1.4 version firmware
cs0 number <optional>

counter of S0 input (KwH). e.g. 0 NOTE: only for LS120 ^1.4 version firmware
ps0 number <optional>

computed S0 power. e.g. 0. NOTE: only for LS120 ^1.4 version firmware
p1 number

P1 consumption counter (low tariff). e.g. 16110.964
p2 number

P2 consumption counter (high tariff). e.g. 896.812
n1 number

N1 production counter (low tariff). e.g. 1570.936
n2 number

N2 production counter (high tariff). e.g. 4250.32
gas number

counter gas-meter (in m^3). e.g. 6161.243
gts number <optional>

time of the last gas measurement (yyMMddhhmm). e.g. 1811182200 NOTE: only for LS120 ^1.4 version firmware
gtm number <optional>

time of the last gas measurement. unix-time-format. e.g. 1542574800 NOTE: only for LS120 ^1.4 version firmware
wtr number <optional>

counter water-meter (in m^3). e.g. 6161.243 NOTE: only for LS120 ^1.6 version firmware and BE meters
wts number <optional>

time of the last water measurement (yyMMddhhmm). e.g. 1811182200 NOTE: only for LS120 ^1.6 version firmware and BE meters
wtm number <optional>

time of the last gas measurement. unix-time-format. e.g. 1542574800 NOTE: NOTE: only for LS120 ^1.6 version firmware and BE meters

advancedStatus is an object containing power information.

Example
// advancedStatus information
{ tm: 1543065732, net: 20289.512, pwr: 640, ts0: 1542562800, cs0: 12345, ps0: 0, p1: 16168.673,
p2: 9942.712, n1: 1570.936, n2: 4250.937, gas: 6192.638, gts: 1811241400, gtm: 1543064400 }

basicStatus

Properties:
Name Type Attributes Description
cnt string

counter in kWh. e.g. ' 16844,321'
pwr number

power consumption in Watt. e.g. 3030
lvl number

moving average level (intensity of reflected light on analog meters) e.g. 73
dev string

deviation of reflection. e.g. '(±0%)'
det string

unknown. e.g. ''
con string

connection status e.g.'OK'
sts string

time until next status update with online monitoring. e.g. '(23)'
ps0 number <optional>

computed S0 power. e.g. 0. NOTE: only for LS120 ^1.4 version firmware
raw number

raw 10-bit light reflection level (without averaging). e.g. 732
net number

netto counter cnt converted to a number. e.g. 16844.321
tm number

time of retrieving info. unix-time-format. e.g. 1542575626

basicStatus is an object containing power information.

Example
// basicStatus information
{ cnt: ' 20289,512', pwr: 640, lvl: 62, dev: '(&plusmn;0%)', det: '', con: 'OK',
sts: '(17)', cs0: ' 12345,0000', ps0: 0, raw: 627, net: 20289.512, tm: 1543065737 }

dateTime

string containing date and time e.g '24-11-18 14:22'

gasLog

Properties:
Name Type Description
un string

the unit of the data 'm3' or 'L' (liter)
tm string

the date/time of the first log entry. e.g. '2018-11-01T00:00:00'
dt number

the entry interval delta in seconds. e.g. 86400 (= 1 day)
val Array.string

an array containing the log entries. Closing entry is always null

contains historic gas usage data

Example
// daily gas usage in the month November
{
	un: 'm3',
	tm: '2018-11-01T00:00:00',
	dt: 86400,
	val: [' 5,580', ' 3,380', ' 4,350', ' 1,960', ' 3,130', ' 3,280', ' 2,500',
	' 2,970', ' 3,780', ' 4,440', ' 2,860', ' 3,470', ' 2,300', ' 4,110',
	' 2,940', ' 4,380', ' 4,860', ' 5,890', ' 5,480', ' 5,670', ' 3,790',
	' 6,390', ' 7,450', ' 3,380', ' 4,350', ' 1,960', ' 3,130', ' 3,780',
	' 5,480', ' 5,670', null ]
}

info

Properties:
Name Type Description
model string

e.g. 'LS120'
mac string

e.g. '72:b8:ad:14:16:2d'
firmware string

e.g. '1.4.1-EL'
host string

e.g. '192.168.1.10'

device information

P1Status

Properties:
Name Type Attributes Description
tr number

Active tariff. 1 = high, 2 = low
pa number <optional>

power peak 15 minutes (Watt, BE only), e.g. 120
pp number <optional>

power peak month (Watt, BE only), e.g. 1280
pts number <optional>

date and time of peak (yyMMddhhmm, BE only), e.g. 2311181715
i1 number

phase 1 current (Ampere), e.g. 5.000
i2 number

phase 2 current (Ampere), e.g. 5.000
i3 number

phase 3 current (Ampere), e.g. 5.000
v1 number

phase 1 voltage (Volt), e.g. 238.400
v2 number

phase 2 voltage (Volt), e.g. 238.400
v3 number

phase 3 voltage (Volt), e.g. 238.400
l1 number

phase 1 power (Watt), e.g. 1129
l2 number

phase 2 power (Watt), e.g. 1129
l3 number

phase 3 power (Watt), e.g. 1129
tm number

time of retrieving info. unix-time-format. e.g. 1542575626

P1Status is an object containing P1 version, tariff and current/voltage/power information per phase.

Example
// P1Status information
{ tr: 2, i1: 5.000, i2: 0.000, i3: 0.000, v1: 238.400, v2: 0.000, v3: 0.000, l1:-1129, l2: 0, l3: 0, tm: 1543065737 }

powerLog

Properties:
Name Type Description
un string

the unit of the data 'Watt' or 'kWh'
tm string

the date/time of the first log entry. e.g. '2018-11-01T00:00:00'
dt number

the entry interval delta in seconds. e.g. 86400 (= 1 day)
val Array.string

an array containing the log entries. Closing entry is always null

contains historic electricity Power data

Example
// daily power usage in the month November
{
	un: 'kWh',
	tm: '2018-11-01T00:00:00',
	dt: 86400,
	val: [' 24,770', ' 14,930', ' 16,270', ' 10,380', ' 14,700', ' 9,000', ' 18,430',
	' 15,420', ' 22,430', ' 22,900', ' 17,820', ' 15,250', ' 13,080', ' 22,780',
	' 12,410', ' 16,090', ' 9,860', ' 15,180', ' 13,790', ' 13,330', ' 20,000',
	' 24,040', ' 18,100', ' 22,430', ' 22,900', ' 17,820', ' 15,250', ' 16,090',
	' 22,430', ' 22,900', null ]
}

rawP1Status

Properties:
Name Type Description
rawP1Status string

DSMR P1 text string

rawP1Status is an object containing the raw string coming from the DSMR P1 interface.

Example
// rawP1Status
/XMX5LGF0000444086356       - start symbol and manufacturer/meter id

1-3:0.2.8(50)               - P1 version (only for newer smart meters)
0-0:1.0.0(220623113116S)    - yymmddhhmmss time of P1 message
0-0:96.1.1(4530303531303034343038363335363138)   - serial number of meter in hex ascii
1-0:1.8.1(002083.849*kWh)   - Total consumed from grid tarriff 1 (low/night)
1-0:1.8.2(002107.144*kWh)   - Total consumed from grid tarriff 2 (high/day)
1-0:2.8.1(000794.052*kWh)   - Total  delivered to grid tarriff 1 (low/night)
1-0:2.8.2(001783.721*kWh)   - Total delivered to grid tarriff 2 (high/day)
0-0:96.14.0(0002)           - Actual tarriff  (1 or 2)
1-0:1.7.0(00.000*kW)        - actual power used from grid
1-0:2.7.0(01.274*kW)        - actual power delivery to grid
0-0:96.7.21(00012)          - Number of power failures in any phase
0-0:96.7.9(00004)           - Number of long power failures in any phase
1-0:99.97.0(2)(0-0:96.7.19)(181022154127S)(0000001018*s)(000101000000W)(0000240127*s)  - Power Failure Event Log (long power failures)
1-0:32.32.0(00009)          - Number of voltage sags in phase L1
1-0:32.36.0(00002)          - Number of voltage swells in phase L1
0-0:96.13.0()               - text message (max 1024 chars)
1-0:32.7.0(240.2*V)         - phase 1 voltage
1-0:31.7.0(005*A)           - phase 1 current
1-0:21.7.0(00.000*kW)       - phase 1 power consumed from grid
1-0:22.7.0(01.274*kW)       - phase 1 power delivered to grid
0-1:24.1.0(003)             - other devices on M-bus
0-1:96.1.0(4730303634303032303133353634383230)   - serial number of gas meter in hex ascii
0-1:24.2.1(220623113008S)(01154.237*m3)  - yymmddhhmmss time of last gas update and Total consumed gas
!4BF5                       - end symbol and optional CRC16-IBM reversed

s0Log

Properties:
Name Type Description
un string

the unit of the data 'Watt' or 'kWh'
tm string

the date/time of the first log entry. e.g. '2018-11-01T00:00:00'
dt number

the entry interval delta in seconds. e.g. 86400 (= 1 day)
val Array.string

an array containing the log entries. Closing entry is always null

contains historic electricity Power data

Example
// daily power usage in the month November
{
	un: 'kWh',
	tm: '2018-11-01T00:00:00',
	dt: 86400,
	val: [' 24,770', ' 14,930', ' 16,270', ' 10,380', ' 14,700', ' 9,000', ' 18,430',
	' 15,420', ' 22,430', ' 22,900', ' 17,820', ' 15,250', ' 13,080', ' 22,780',
	' 12,410', ' 16,090', ' 9,860', ' 15,180', ' 13,790', ' 13,330', ' 20,000',
	' 24,040', ' 18,100', ' 22,430', ' 22,900', ' 17,820', ' 15,250', ' 16,090',
	' 22,430', ' 22,900', null ]
}

sessionOptions

Properties:
Name Type Attributes Default Description
password string <optional>
 ''

The login password (Only for LS120). Defaults to no password.
host string <optional>

The url or ip address of the youless device. Leave undefined to try autodiscovery.
port number <optional>
 80

The port of the youless device. Defaults to 80.
timeout number <optional>
 10000

http timeout in milliseconds. Defaults to 10000ms.
reversed boolean <optional>
 false

Reverse the peak and offPeak meters. Required in Belgium.

Set of configurable options to set on the youless class or during login

Example
// session options
{ password: 'mySecretPassword',
  host:'10.0.0.12',
  port: 80,
  timeout: 5000,
}

waterLog

Properties:
Name Type Description
un string

the unit of the data 'm3' or 'L' (liter)
tm string

the date/time of the first log entry. e.g. '2018-11-01T00:00:00'
dt number

the entry interval delta in seconds. e.g. 86400 (= 1 day)
val Array.string

an array containing the log entries. Closing entry is always null

contains historic water usage data

Example
// daily water usage in the month November
{
  un: 'm3',
  tm: '2023-11-01T00:00:00',
  dt: 86400,
  val: [
    ' 0,160', ' 0,450', ' 0,100',
    ' 0,550', ' 0,290', ' 0,210',
    ' 0,190', ' 0,170', ' 0,200',
    ' 0,220', ' 0,220', ' 0,170',
    ' 0,110', ' 0,140', ' 0,150',
    ' 0,200', ' 0,240', ' 0,240',
    ' 0,160', ' 0,140', ' 0,270',
    ' 0,110', ' 0,330', ' 0,130',
    ' 0,000', ' 0,030', ' 0,150',
    null
  ]
}