Module IEC60870_5_104_Slave

The class that's used to create and manage IEC60870_5_104 slave communication protocol.

Info:

  • Copyright: Debaru Kft. 2017
  • Release:
  • License: GNU
  • Author: Debaru Kft

Functions

IEC60870_5_104_Slave () Creates a IEC60870_5_104_Slave communication platform.
copy () Copies an existing slave device and returns a new class instance.
start () Starts the IEC communication.
type (type) Sets the type of the IEC60870_5_104_Slave.
is_connected () Returns a IEC104SlavePointLocator that the user can test for connection.
is_error () Returns a IEC104SlavePointLocator that the user can test for error.

Fields

message_fragment_timeout Represents the timeout in ms for message fragmentation.
cot_field_length Represents length of the cause of transmission field.
common_address_field_length Represents the length of the common address field.
ioa_field_length Represents the input-output address field length.
max_time_no_ack_received Represents the time the system waits for an acknowledge to arrive.
max_time_no_ack_sent Represents the time the system waits for an acknowledge to be sent.
max_idle_time Represents the time the system idles until it throws an error.
max_unconfirmed_ipdus_received Represents the number of unconfirmed ipdbus messages that the system tolerates.
dt_wait_time Unknown.
tcp_port Port for the communication.
common_address Common address for the IEC communication.
accept_clock_sync Allows the devices to sync their times.

IEC104SlavePointLocator

assign (tag) Assign an existing tag to a IEC104 slave point.
tag () Create a new tag for a IEC104 slave point.
address (address) Set address in IEC104 slave point locator.
tx_on_change (tx_on_change) Set if a value change should trigger transmission.
tx_period (period_ms) Set a period to transmit current value.
tx_significance (value) Set minimum value difference to transmit current value.


Functions

IEC60870_5_104_Slave ()
Creates a IEC60870_5_104_Slave communication platform.
copy ()
Copies an existing slave device and returns a new class instance.

Returns:

    IEC60870_5_104_Slave
start ()
Starts the IEC communication. Must be called once at initialization, after setting up IEC104 points.

Returns:

    bool
type (type)
Sets the type of the IEC60870_5_104_Slave.

Parameters:

Returns:

    IEC104SlavePointLocator
is_connected ()
Returns a IEC104SlavePointLocator that the user can test for connection.

Returns:

    IEC104SlavePointLocator
is_error ()
Returns a IEC104SlavePointLocator that the user can test for error.

Returns:

    IEC104SlavePointLocator

Fields

message_fragment_timeout
Represents the timeout in ms for message fragmentation.
  • type int (default: "5000")
cot_field_length
Represents length of the cause of transmission field.
  • type int (default: 2)
common_address_field_length
Represents the length of the common address field.
  • type int (default: 2)
ioa_field_length
Represents the input-output address field length.
  • type int (default: 3)
max_time_no_ack_received
Represents the time the system waits for an acknowledge to arrive. Resolution is in ms
  • type int (default: 15000)
max_time_no_ack_sent
Represents the time the system waits for an acknowledge to be sent. Resolution is in ms
  • type int (default: 10000)
max_idle_time
Represents the time the system idles until it throws an error. Resolution is in ms
  • type int (default: 20000)
max_unconfirmed_ipdus_received
Represents the number of unconfirmed ipdbus messages that the system tolerates.
  • type int (default: 8)
dt_wait_time
Unknown. Resolution is in ms.
  • type int (default: 10000)
tcp_port
Port for the communication.
  • type int (default: 2404)
common_address
Common address for the IEC communication.
  • type int (default: 1)
accept_clock_sync
Allows the devices to sync their times.
  • type bool (default: TRUE)

IEC104SlavePointLocator

assign (tag)
Assign an existing tag to a IEC104 slave point.

Parameters:

  • tag Tag
tag ()
Create a new tag for a IEC104 slave point.
address (address)
Set address in IEC104 slave point locator.

Parameters:

tx_on_change (tx_on_change)
Set if a value change should trigger transmission.

Parameters:

  • tx_on_change bool (default: TRUE (measurements: FALSE))
tx_period (period_ms)
Set a period to transmit current value. Resolution is in ms. (0: OFF)

Parameters:

  • period_ms int (default: 0 (measurements: 2000))
tx_significance (value)
Set minimum value difference to transmit current value. (0: OFF)

Parameters:

generated by LDoc 1.4.6 Last updated 2023-09-25 09:31:08