Type definitions#

Modules#

Enumerations#

enum

sl_rail_sdk_wmbus_function_code_t {

WMBUS_FUNCTION_SND_NKE = 0x0

WMBUS_FUNCTION_SND_UD = 0x3

WMBUS_FUNCTION_SND_NR = 0x4

WMBUS_FUNCTION_SND_IR = 0x6

WMBUS_FUNCTION_ACC_NR = 0x7

WMBUS_FUNCTION_ACC_DMD = 0x8

WMBUS_FUNCTION_REQ_UD1 = 0xA

WMBUS_FUNCTION_REQ_UD2 = 0xB

}

Function code to use in the first block's C-field.

enum

sl_rail_sdk_wmbus_device_type_t {

WMBUS_DEVICE_OTHER = 0x00

WMBUS_DEVICE_OIL_METER

WMBUS_DEVICE_ELECTRICITY_METER

WMBUS_DEVICE_GAS_METER

WMBUS_DEVICE_HEAT_METER

WMBUS_DEVICE_STEAM_METER

WMBUS_DEVICE_WARM_WATER_METER

WMBUS_DEVICE_WATER_METER

WMBUS_DEVICE_HEAT_COST_ALLOCATOR

WMBUS_DEVICE_COMPRESSED_AIR

WMBUS_DEVICE_COOLING_METER_OUTLET

WMBUS_DEVICE_COOLING_METER_INLET

WMBUS_DEVICE_HEAT_METER_INLET

WMBUS_DEVICE_COMBINED_HEAT_COOLING_METER

WMBUS_DEVICE_BUS_SYSTEM_COMPONENT

WMBUS_DEVICE_CALORIFIC_VALUE = 0x14

WMBUS_DEVICE_HOT_WATER_METER

WMBUS_DEVICE_COLD_WATER_METER

WMBUS_DEVICE_DUAL_WATER_METER

WMBUS_DEVICE_PRESSURE_METER

WMBUS_DEVICE_AD_CONVERTER

WMBUS_DEVICE_SMOKE_DETECTOR

WMBUS_DEVICE_ROOM_SENSOR

WMBUS_DEVICE_GAS_DETECTOR

WMBUS_DEVICE_BREAKER = 0x20

WMBUS_DEVICE_VALVE

WMBUS_DEVICE_CUSTOMER_UNIT = 0x25

WMBUS_DEVICE_WASTE_WATER_METER = 0x28

WMBUS_DEVICE_GARBAGE

WMBUS_DEVICE_CARBON_DIOXIDE

WMBUS_DEVICE_COMMUNICATION_CONTROLLER = 0x31

WMBUS_DEVICE_UNIDIRECTIONAL_REPEATER

WMBUS_DEVICE_BIDIRECTIONAL_REPEATER

WMBUS_DEVICE_RADIO_CONVERTER_SYSTEM = 0x36

WMBUS_DEVICE_RADIO_CONVERTER_METER

}

Device type to be used in the address field(s)

enum

sl_rail_sdk_wmbus_ci_field_t {

WMBUS_CI_DATA_TO_METER_NONE = 0x51

WMBUS_CI_MBUS_DATA_TO_METER_SHORT = 0x5A

WMBUS_CI_MBUS_DATA_TO_METER_LONG

WMBUS_CI_COSEM_DATA_TO_METER_LONG = 0x60

WMBUS_CI_COSEM_DATA_TO_METER_SHORT

WMBUS_CI_OBIS_DATA_TO_METER_LONG = 0x64

WMBUS_CI_OBIS_DATA_TO_METER_SHORT

WMBUS_CI_EN13757_3_DATA_TO_METER_NONE = 0x69

WMBUS_CI_EN13757_3_DATA_TO_METER_SHORT

WMBUS_CI_EN13757_3_DATA_TO_METER_LONG

WMBUS_CI_CLOCK_SYNC_ABSOLUTE

WMBUS_CI_CLOCK_SYNC_RELATIVE

WMBUS_CI_APPLICATION_ERROR_SHORT

WMBUS_CI_APPLICATION_ERROR_LONG

WMBUS_CI_APPLICATION_ERROR_NONE

WMBUS_CI_ALARM_NONE

WMBUS_CI_EN13757_3_APPLICATION_LONG

WMBUS_CI_EN13757_3_APPLICATION_CF_LONG

WMBUS_CI_ALARM_SHORT

WMBUS_CI_ALARM_LONG

WMBUS_CI_EN13757_3_APPLICATION_NONE = 0x78

WMBUS_CI_EN13757_3_APPLICATION_CF_NONE

WMBUS_CI_EN13757_3_APPLICATION_SHORT

WMBUS_CI_EN13757_3_APPLICATION_CF_SHORT

WMBUS_CI_COSEM_APPLICATION_LONG

WMBUS_CI_COSEM_APPLICATION_SHORT

WMBUS_CI_OBIS_APPLICATION_LONG

WMBUS_CI_OBIS_APPLICATION_SHORT

WMBUS_CI_EN13757_3_TRANSPORT_TO_METER_LONG

WMBUS_CI_NETWORK_LAYER_DATA

WMBUS_CI_FOR_FUTURE_USE

WMBUS_CI_NETWORK_MANAGEMENT_APPLICATION

WMBUS_CI_TRANSPORT_TO_METER_MBUS_COMPACT

WMBUS_CI_NETWORK_MANAGEMENT_DATA = 0x89

WMBUS_CI_EN13757_3_TRANSPORT_FROM_METER_SHORT

WMBUS_CI_EN13757_3_TRANSPORT_FROM_METER_LONG

WMBUS_CI_EXTENDED_LINK_LAYER1

WMBUS_CI_EXTENDED_LINK_LAYER2

WMBUS_CI_EXTENDED_LINK_LAYER3

WMBUS_CI_EXTENDED_LINK_LAYER4

}

CI field codes.

enum

sl_rail_sdk_wmbus_status_t {

WMBUS_STATUS_APPLICATION_BUSY = 0x1

WMBUS_STATUS_APPLICATION_ERROR = 0x2

WMBUS_STATUS_ABNORMAL_CONDITION = 0x3

WMBUS_STATUS_POWER_LOW = 1 << 2

WMBUS_STATUS_PERMANENT_ERROR = 1 << 3

WMBUS_STATUS_TEMPORARY_ERROR = 1 << 4

}

Application errors coded into the status field.

enum

sl_rail_sdk_wmbus_accessibility_t {

WMBUS_ACCESSIBILITY_NO_ACCESS = 0

WMBUS_ACCESSIBILITY_TEMPORARY_NO_ACCESS

WMBUS_ACCESSIBILITY_LIMITED_ACCESS

WMBUS_ACCESSIBILITY_UNLIMITED_ACCESS

}

Accessibility settings in the config word.

enum

sl_rail_sdk_wmbus_frame_dib_function_t {

WMBUS_DIB_FUNCTION_INSTANTANEOUS

WMBUS_DIB_FUNCTION_MINIMUM

WMBUS_DIB_FUNCTION_MAXIMUM

WMBUS_DIB_FUNCTION_ERROR

}

Values for function field in DIB.

enum

sl_rail_sdk_wmbus_mode_t {

WMBUS_MODE_S

WMBUS_MODE_T_METER

WMBUS_MODE_T_COLLECTOR

WMBUS_MODE_C

WMBUS_MODE_F

WMBUS_MODE_R2

WMBUS_MODE_N_24

WMBUS_MODE_N_48

WMBUS_MODE_N_192

}

MBUS modes.

Enumeration Documentation#

sl_rail_sdk_wmbus_function_code_t#

sl_rail_sdk_wmbus_function_code_t

Function code to use in the first block's C-field.

Enumerator
WMBUS_FUNCTION_SND_NKE	SND-NKE.
WMBUS_FUNCTION_SND_UD	SND-UD/SND-UD2.
WMBUS_FUNCTION_SND_NR	SND-NR.
WMBUS_FUNCTION_SND_IR	SND-IR.
WMBUS_FUNCTION_ACC_NR	ACC-NR.
WMBUS_FUNCTION_ACC_DMD	ACC-DMD.
WMBUS_FUNCTION_REQ_UD1	REQ-UD1.
WMBUS_FUNCTION_REQ_UD2	REQ-UD2.

Definition at line 56 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_support/sl_rail_sdk_wmbus_support.h

sl_rail_sdk_wmbus_device_type_t#

sl_rail_sdk_wmbus_device_type_t

Device type to be used in the address field(s)

Enumerator
WMBUS_DEVICE_OTHER	Other.
WMBUS_DEVICE_OIL_METER	Oil meter.
WMBUS_DEVICE_ELECTRICITY_METER	Electricity meter.
WMBUS_DEVICE_GAS_METER	Gas meter.
WMBUS_DEVICE_HEAT_METER	Heat meter.
WMBUS_DEVICE_STEAM_METER	Steam meter.
WMBUS_DEVICE_WARM_WATER_METER	Warm water meter (30-90C)
WMBUS_DEVICE_WATER_METER	Water meter.
WMBUS_DEVICE_HEAT_COST_ALLOCATOR	Heat cost allocator.
WMBUS_DEVICE_COMPRESSED_AIR	Compressed air.
WMBUS_DEVICE_COOLING_METER_OUTLET	Cooling meter (volume measured at return temperature: outlet)
WMBUS_DEVICE_COOLING_METER_INLET	Cooling meter (volume measured at flow temperature: inlet)
WMBUS_DEVICE_HEAT_METER_INLET	Heat meter (volume measured at flow temperature: inlet)
WMBUS_DEVICE_COMBINED_HEAT_COOLING_METER	Combined heat/cooling meter.
WMBUS_DEVICE_BUS_SYSTEM_COMPONENT	Bus/system component.
WMBUS_DEVICE_CALORIFIC_VALUE	Calorific value.
WMBUS_DEVICE_HOT_WATER_METER	Hot water meter (>90C)
WMBUS_DEVICE_COLD_WATER_METER	Cold water meter.
WMBUS_DEVICE_DUAL_WATER_METER	Dual register (hot/cold) water meter.
WMBUS_DEVICE_PRESSURE_METER	Pressure meter.
WMBUS_DEVICE_AD_CONVERTER	A/D converter.
WMBUS_DEVICE_SMOKE_DETECTOR	Smoke detector.
WMBUS_DEVICE_ROOM_SENSOR	Room sensor (e.g.
WMBUS_DEVICE_GAS_DETECTOR	Gas detector.
WMBUS_DEVICE_BREAKER	Breaker (electricity)
WMBUS_DEVICE_VALVE	Valve (gas or water)
WMBUS_DEVICE_CUSTOMER_UNIT	Customer unit (display device)
WMBUS_DEVICE_WASTE_WATER_METER	Waste water meter.
WMBUS_DEVICE_GARBAGE	Garbage.
WMBUS_DEVICE_CARBON_DIOXIDE	Reserved for carbon dioxide.
WMBUS_DEVICE_COMMUNICATION_CONTROLLER	Communication controller (Gateway)
WMBUS_DEVICE_UNIDIRECTIONAL_REPEATER	Unidirectional repeater.
WMBUS_DEVICE_BIDIRECTIONAL_REPEATER	Bidirectional repeater.
WMBUS_DEVICE_RADIO_CONVERTER_SYSTEM	Radio converter (system side)
WMBUS_DEVICE_RADIO_CONVERTER_METER	Radio converter (meter side)

Definition at line 71 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_support/sl_rail_sdk_wmbus_support.h

sl_rail_sdk_wmbus_ci_field_t#

sl_rail_sdk_wmbus_ci_field_t

CI field codes.

Enumerator
WMBUS_CI_DATA_TO_METER_NONE	Data sent by readout device to the Meter without transport layer.
WMBUS_CI_MBUS_DATA_TO_METER_SHORT	MBUS data sent by readout device to the Meter with short transport layer.
WMBUS_CI_MBUS_DATA_TO_METER_LONG	MBUS data sent by readout device to the Meter with long transport layer.
WMBUS_CI_COSEM_DATA_TO_METER_LONG	COSEM data sent by readout device to the Meter with long transport layer.
WMBUS_CI_COSEM_DATA_TO_METER_SHORT	COSEM data sent by readout device to the Meter with short transport layer.
WMBUS_CI_OBIS_DATA_TO_METER_LONG	OBIS based data sent by readout device to the Meter with long transport layer.
WMBUS_CI_OBIS_DATA_TO_METER_SHORT	OBIS based data sent by readout device to the Meter with short transport layer.
WMBUS_CI_EN13757_3_DATA_TO_METER_NONE	EN13757-3 application layer with Format frame and no transport layer.
WMBUS_CI_EN13757_3_DATA_TO_METER_SHORT	EN13757-3 application layer with Format frame and short transport layer.
WMBUS_CI_EN13757_3_DATA_TO_METER_LONG	EN13757-3 application layer with Format frame and long transport layer.
WMBUS_CI_CLOCK_SYNC_ABSOLUTE	Clock synchronisation (absolute)
WMBUS_CI_CLOCK_SYNC_RELATIVE	Clock synchronisation (relative)
WMBUS_CI_APPLICATION_ERROR_SHORT	Application error from Meter with short transport layer.
WMBUS_CI_APPLICATION_ERROR_LONG	Application error from Meter with long transport layer.
WMBUS_CI_APPLICATION_ERROR_NONE	Application error from Meter with no transport layer.
WMBUS_CI_ALARM_NONE	Alarm from Meter without transport layer.
WMBUS_CI_EN13757_3_APPLICATION_LONG	EN13757-3 application layer with long transport layer.
WMBUS_CI_EN13757_3_APPLICATION_CF_LONG	EN13757-3 application layer with compact frame and long transport layer.
WMBUS_CI_ALARM_SHORT	Alarm from Meter with short transport layer.
WMBUS_CI_ALARM_LONG	Alarm from Meter with long transport layer.
WMBUS_CI_EN13757_3_APPLICATION_NONE	EN13757-3 application layer with no transport layer.
WMBUS_CI_EN13757_3_APPLICATION_CF_NONE	EN13757-3 application layer with compact frame and no transport layer.
WMBUS_CI_EN13757_3_APPLICATION_SHORT	EN13757-3 application layer with short transport layer.
WMBUS_CI_EN13757_3_APPLICATION_CF_SHORT	EN13757-3 application layer with compact frame and short transport layer.
WMBUS_CI_COSEM_APPLICATION_LONG	COSEM application layer with long transport layer.
WMBUS_CI_COSEM_APPLICATION_SHORT	COSEM application layer with short transport layer.
WMBUS_CI_OBIS_APPLICATION_LONG	OBIS based application layer with long transport layer.
WMBUS_CI_OBIS_APPLICATION_SHORT	OBIS based application layer with short transport layer.
WMBUS_CI_EN13757_3_TRANSPORT_TO_METER_LONG	EN13757-3 Transport layer (long) from readout device to the meter.
WMBUS_CI_NETWORK_LAYER_DATA	Network layer data.
WMBUS_CI_FOR_FUTURE_USE	For future use.
WMBUS_CI_NETWORK_MANAGEMENT_APPLICATION	Network management application.
WMBUS_CI_TRANSPORT_TO_METER_MBUS_COMPACT	Transport layer to Meter (M Bus-Compact frame expected)
WMBUS_CI_NETWORK_MANAGEMENT_DATA	Reserved for Network management data (EN 13757-5)
WMBUS_CI_EN13757_3_TRANSPORT_FROM_METER_SHORT	EN13757-3 Transport layer (short) from the meter to the readout device.
WMBUS_CI_EN13757_3_TRANSPORT_FROM_METER_LONG	EN13757-3 Transport layer (long) from the meter to the readout device.
WMBUS_CI_EXTENDED_LINK_LAYER1	Extended Link Layer I (2B)
WMBUS_CI_EXTENDED_LINK_LAYER2	Extended Link Layer II (8B)
WMBUS_CI_EXTENDED_LINK_LAYER3	Extended Link Layer III (10B)
WMBUS_CI_EXTENDED_LINK_LAYER4	Extended Link Layer IV (16B)

Definition at line 113 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_support/sl_rail_sdk_wmbus_support.h

sl_rail_sdk_wmbus_status_t#

sl_rail_sdk_wmbus_status_t

Application errors coded into the status field.

Enumerator
WMBUS_STATUS_APPLICATION_BUSY	Application busy.
WMBUS_STATUS_APPLICATION_ERROR	Any application error.
WMBUS_STATUS_ABNORMAL_CONDITION	Abnormal condition/alarm.
WMBUS_STATUS_POWER_LOW	Power low.
WMBUS_STATUS_PERMANENT_ERROR	Permanent error.
WMBUS_STATUS_TEMPORARY_ERROR	Temporary error.

Definition at line 160 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_support/sl_rail_sdk_wmbus_support.h

sl_rail_sdk_wmbus_accessibility_t#

sl_rail_sdk_wmbus_accessibility_t

Accessibility settings in the config word.

Enumerator
WMBUS_ACCESSIBILITY_NO_ACCESS	No access (unidirectional)
WMBUS_ACCESSIBILITY_TEMPORARY_NO_ACCESS	Bidirectional, temporary no access.
WMBUS_ACCESSIBILITY_LIMITED_ACCESS	Bidirectional, limited access (short time after TX)
WMBUS_ACCESSIBILITY_UNLIMITED_ACCESS	Bidirectional, unlimited access.

Definition at line 173 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_support/sl_rail_sdk_wmbus_support.h

sl_rail_sdk_wmbus_frame_dib_function_t#

sl_rail_sdk_wmbus_frame_dib_function_t

Values for function field in DIB.

Enumerator
WMBUS_DIB_FUNCTION_INSTANTANEOUS	Instantaneous value.
WMBUS_DIB_FUNCTION_MINIMUM	Minimum value.
WMBUS_DIB_FUNCTION_MAXIMUM	Maximum value.
WMBUS_DIB_FUNCTION_ERROR	Value during error state.

Definition at line 267 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_support/sl_rail_sdk_wmbus_support.h

sl_rail_sdk_wmbus_mode_t#

sl_rail_sdk_wmbus_mode_t

MBUS modes.

Enumerator
WMBUS_MODE_S	S mode.
WMBUS_MODE_T_METER	T mode, Meter to Other.
WMBUS_MODE_T_COLLECTOR	T mode, Other to Meter.
WMBUS_MODE_C	C mode.
WMBUS_MODE_F	F mode.
WMBUS_MODE_R2	R2 mode.
WMBUS_MODE_N_24	N mode, 2.4kbps (channel 2a and 2b)
WMBUS_MODE_N_48	N mode, 4.8kbps (channel 1a, 1b, 3a and 3b)
WMBUS_MODE_N_192	N mode, 19.2kbps (channel 0)

Definition at line 278 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_support/sl_rail_sdk_wmbus_support.h