Handler

class secsgem.secs.handler.SecsHandler(settings)[source]

Baseclass for creating Host/Equipment models. This layer contains the SECS functionality.

Inherit from this class and override required functions.

property settings: Settings: Get the setting object.

property protocol: Protocol: Get the connection for the handler.

enable()[source]: Enable the connection.

disable()[source]: Disable the connection.

send_response(function, system)[source]

Wrapper for connections send_response function.

Return type:: bool

send_and_waitfor_response(function)[source]

Wrapper for connections send_and_waitfor_response function.

Return type:: Message | None

send_stream_function(function)[source]

Wrapper for connections send_stream_function function.

Return type:: bool

property events: EventProducer: Wrapper for connections events.

property callbacks: CallbackHandler: Property for callback handling.

register_stream_function(stream, function, callback)[source]

Register the function callback for stream and function.

Parameters:

stream (int) – stream to register callback for
function (int) – function to register callback for
callback (Callable) – method to call when stream and functions is received

unregister_stream_function(stream, function)[source]

Unregister the function callback for stream and function.

Parameters:

stream (int) – stream to unregister callback for
function (int) – function to register callback for

disable_ceids()[source]

Disable all Collection Events.

Return type:: Message | None

disable_ceid_reports()[source]

Disable all Collection Event Reports.

Return type:: Message | None

list_svs(svs=None)[source]

Get list of available Status Variables.

Parameters:: svs (list[str | int] | None) – Status Variables to list
Return type:: SecsStreamFunction
Returns:: available Status Variables

request_svs(svs)[source]

Request contents of supplied Status Variables.

Parameters:: svs (list[str | int]) – Status Variables to request
Return type:: SecsStreamFunction
Returns:: values of requested Status Variables

request_sv(sv_id)[source]

Request contents of one Status Variable.

Parameters:: sv_id (int | str) – id of Status Variable
Return type:: int | str | None
Returns:: value of requested Status Variable

list_ecs(ecs=None)[source]

Get list of available Equipment Constants.

Parameters:: ecs (list[str | int] | None) – Equipment Constants to list
Return type:: SecsStreamFunction
Returns:: available Equipment Constants

request_ecs(ecs)[source]

Request contents of supplied Equipment Constants.

Parameters:: ecs (list[int | str]) – Equipment Constants to request
Return type:: SecsStreamFunction
Returns:: values of requested Equipment Constants

request_ec(ec_id)[source]

Request contents of one Equipment Constant.

Parameters:: ec_id (int | str) – id of Equipment Constant
Return type:: SecsStreamFunction
Returns:: value of requested Equipment Constant

set_ecs(ecs)[source]

Set contents of supplied Equipment Constants.

Parameters:: ecs (list[list[str | int | float]]) – list containing list of id / value pairs
Return type:: int

set_ec(ec_id, value)[source]

Set contents of one Equipment Constant.

Parameters:

ec_id (int | str) – id of Equipment Constant
value (int | str | float) – new content of Equipment Constant

Return type:

int

send_equipment_terminal(terminal_id, text)[source]

Set text to equipment terminal.

Parameters:

terminal_id (int) – ID of terminal
text (str) – text to send

Return type:

Message | None

are_you_there()[source]

Check if remote is still replying.

Return type:: Message | None

stream_function(stream, function)[source]

Get class for stream and function.

Parameters:

stream (int) – stream to get class for
function (int) – function to get class for

Return type:

type[SecsStreamFunction]

Returns:

class for function

property data_items: DataItems

Get data item container.

Returns:: data item container