Expand description
Typed attributes for COSEM interface classes (IEC 62056-6-2).
Each IC has specific attribute types defined in the standard. This module
provides strongly-typed structs for these attributes, replacing the generic
CosemDataType where possible while maintaining BER compatibility.
Structs§
- Access
Right access_right— structure { attribute_access, method_access } Used by Association LN (attr 2) and Association SN.- Action
Item action_item— structure { script_logical_name, script_selector } Used in Register Monitor, Limiter, and other ICs.- Action
Set action_set— structure { action_up, action_down } Used in Register Monitor (attr 4).- Action
Specification action_specification— structure { service_id, class_id, logical_name, index, parameter } Used in Script Table (attr 2).- Activity
Calendar Attrs - Activity calendar class (class_id = 20) attributes.
- Arbitrator
Attrs - Arbitrator class (class_id = 68) attributes.
- Associated
Partners Id associated_partners_type— structure { client_SAP, server_SAP } Used in Association LN attr 3.- Association
LnAttrs - Association LN class (class_id = 15) attributes.
- Attribute
Access Item attribute_access_item— structure { attribute_id, access_mode, access_selectors }- BitString
- Bit-string value (held as raw octets).
- Capture
Object Definition - Capture object definition: structure { class_id, logical_name, attribute_index, data_index } per IEC 62056-6-2, 4.3.6.2.
- Cell
Info - Cell information for GSM Diagnostic. Structure with cell_id, location_id, imsi, imei, etc.
- Certificate
- Certificate entry for Security Setup. Structure { data: octet-string }
- Clock
Attrs - Clock class (class_id = 8) attributes.
- Communication
Window communication_windowentry — structure { begin, end: date-time } Used in Push Setup (attr 4).- Confirmation
Parameters - Confirmation parameters for Push Setup v2. Structure { data: octet-string }
- Data
Attrs - Data class (class_id = 1) attributes.
- Data
Protection Attrs - Data protection class (class_id = 30) attributes.
- Date
Time - Date-time value (12 octets) per IEC 62056-6-2, 4.1.6.1.
- DayProfile
day_profile— structure { day_id, day_schedule: array day_profile_action } Used in Activity Calendar (attr 5/9).- DayProfile
Action day_profile_action— structure { start_time, script_logical_name, script_selector } Used insideday_profile.- Demand
Register Attrs - Demand register class (class_id = 5) attributes.
- Disconnect
Control Attrs - Disconnect control class (class_id = 70) attributes.
- Emergency
Profile emergency_profile— structure { emergency_profile_id, emergency_activation_time, emergency_duration } Used in Limiter (attr 8).- Executed
Script single_action_schedule_executed_script— structure { script_logical_name, script_selector } Used in Single Action Schedule (attr 2).- Execution
Time - Execution time structure for Single Action Schedule. Structure { time: octet-string, date: octet-string }
- Extended
Register Attrs - Extended register class (class_id = 4) attributes.
- Gprs
Modem Setup Attrs - GPRS modem setup class (class_id = 45) attributes.
- GsmAdjacent
Cell gsm_adjacent_cell— structure { cell_id, signal_quality, signal_strength } Used in GSM Diagnostic (attr 9).- GsmDiagnostic
Attrs - GSM diagnostic class (class_id = 47) attributes.
- GsmService
Parameter - GSM service parameter for GPRS Modem Setup. Structure { delay_class, reliability_class, precedence_class, peak_throughput, mean_throughput }
- IecHdlc
Setup Attrs - IEC HDLC setup class (class_id = 23) attributes.
- IecLocal
Port Setup Attrs - IEC local port setup class (class_id = 19) attributes.
- Image
ToActivate Info image_to_activate_infoentry — structure { image_block_number, image_block_value } Used in Image Transfer (attr 7).- Image
Transfer Attrs - Image transfer class (class_id = 18) attributes.
- IpOption
ip_option— structure { option_type: unsigned, option_value: octet-string } Used in IPv4/IPv6 setup.- Ipv4
Setup Attrs - IPv4 setup class (class_id = 42) attributes.
- Ipv6
Setup Attrs - IPv6 setup class (class_id = 48) attributes.
- Limiter
Action limiter_action— structure { action_over_threshold, action_under_threshold } Used in Limiter (attr 11).- Limiter
Attrs - Limiter class (class_id = 71) attributes.
- MacAddress
Setup Attrs - MAC address setup class (class_id = 43) attributes.
- Mbus
Slave Port Setup Attrs - M-Bus slave port setup class (class_id = 25) attributes.
- Method
Access Item method_access_item— structure { method_id, access_mode }- Neighbor
Discovery Setup neighbor_discovery_setup— structure { ip_address, hardware_address } Used in IPv6 neighbor discovery.- Object
Definition object_definition— structure { class_id, logical_name } Used in Register Activation (attr 2).- Object
List Element object_list_element— structure { class_id, version, logical_name, access_rights } Used in Association LN attr 2 (object_list).- Profile
Generic Attrs - Profile generic class (class_id = 7) attributes.
- Protection
Object protection_object— structure { class_id, logical_name, attribute_index } Used in Data Protection and Security Setup.- Push
Protection Parameter - Push protection parameter (Push Setup v1+). Structure { data: octet-string }
- Quality
OfService - Quality of Service structure for GPRS Modem Setup. Structure { default: gsm_service_parameter, requested: gsm_service_parameter }
- Register
ActMask register_act_mask— structure { mask_name, index_list: array unsigned } Used in Register Activation (attr 3).- Register
Attrs - Register class (class_id = 3) attributes.
- Register
Monitor Attrs - Register monitor class (class_id = 21) attributes.
- SapAssignment
Attrs - SAP assignment class (class_id = 17) attributes.
- SapAssignment
Entry sap_assignment_entry— structure { SAP: long-unsigned, logical_device_name: octet-string } Used in SAP Assignment (attr 2).- Scaler
Unit - ScalerUnit: structure { scaler: integer, unit: enum } per IEC 62056-6-2, Table 41.
- Schedule
Attrs - Schedule class (class_id = 10) attributes.
- Schedule
Table Entry schedule_table_entry— structure { index, enable, script_logical_name, … } Used in Schedule (attr 2).- Script
script— structure { script_identifier, actions } Used in Script Table (attr 2).- Script
Table Attrs - Script table class (class_id = 9) attributes.
- Season
Profile season_profile— structure { season_profile_name, season_start, week_name } Used in Activity Calendar (attr 3/7).- Security
Setup Attrs - Security setup class (class_id = 64) attributes.
- Send
Destination AndMethod send_destination_and_method— structure { transport_service, destination, message } Used in Push Setup (attr 3).- Single
Action Schedule Attrs - Single action schedule class (class_id = 22) attributes.
- Special
DayEntry spec_day_entry— structure { index, specialday_date, day_id } Used in Special Days Table (attr 2).- Special
Days Table Attrs - Special days table class (class_id = 11) attributes.
- TcpUdp
Setup Attrs - TCP-UDP setup class (class_id = 41) attributes.
- User
- User entry for Association LN v2 user_list. Structure { user_id: unsigned, user_name: visible-string }
- Value
Definition value_definition— structure { class_id, logical_name, attribute_index } Used in Register Monitor (attr 3) and Limiter (attr 2).- Week
Profile week_profile— structure { week_profile_name, monday..sunday: day_id } Used in Activity Calendar (attr 4/8).- XDLMS
Context Info xDLMS-context-type— structure { conformance, max_receive_pdu_size, … } Used in Association LN attr 5.
Enums§
- Association
Status - Association status (IEC 62056-6-2, 4.4.3.2).
- Clock
Base - Clock base (IEC 62056-6-2, 4.3.7).
- Context
Name context_name_type— CHOICE of structure or octet-string. Used in Association LN attr 4.- Sort
Method - Sort method for Profile generic (IEC 62056-6-2, 4.3.6.2).
Type Aliases§
- Choice
- CHOICE type — any COSEM data type (for value, status, etc.). This maintains backward compatibility with the generic CosemDataType.
- Logical
Name - Logical name (OBIS code) — attribute 1 of all ICs.