Handler

class secsgem.hsms.handler.HsmsHandler(address, port, active, session_id, name, custom_connection_handler=None)

Bases: object

Baseclass for creating Host/Equipment models.

This layer contains the HSMS functionality. Inherit from this class and override required functions.

events

Property for event handling.

callbacks

Property for callback handling.

get_next_system_counter()

Returns the next System.

Returns:System for the next command Return type:integer

on_connection_established(_)

Connection was established.

on_connection_before_closed(_)

Connection is about to be closed.

on_connection_closed(_)

Connection was closed.

on_connection_packet_received(_, packet)

Packet received by connection.

Parameters:packet (secsgem.hsms.packets.HsmsPacket) – received data packet

enable()

Enables the connection.

disable()

Disables the connection.

send_stream_function(packet)

Send the packet and wait for the response.

Parameters:packet (secsgem.secs.functionbase.SecsStreamFunction) – packet to be sent

send_and_waitfor_response(packet)

Send the packet and wait for the response.

Parameters:packet (secsgem.secs.functionbase.SecsStreamFunction) – packet to be sent Returns:Packet that was received Return type:secsgem.hsms.packets.HsmsPacket

send_response(function, system)

Send response function for system.

Parameters:

• function (secsgem.secs.functionbase.SecsStreamFunction) – function to be sent
• system (integer) – system to reply to

send_select_req()

Send a Select Request to the remote host.

Returns:System of the sent request Return type:integer

send_select_rsp(system_id)

Send a Select Response to the remote host.

Parameters:system_id (integer) – System of the request to reply for

send_linktest_req()

Send a Linktest Request to the remote host.

Returns:System of the sent request Return type:integer

send_linktest_rsp(system_id)

Send a Linktest Response to the remote host.

Parameters:system_id (integer) – System of the request to reply for

send_deselect_req()

Send a Deselect Request to the remote host.

Returns:System of the sent request Return type:integer

send_deselect_rsp(system_id)

Send a Deselect Response to the remote host.

Parameters:system_id (integer) – System of the request to reply for

send_reject_rsp(system_id, s_type, reason)

Send a Reject Response to the remote host.

Parameters:

• system_id (integer) – System of the request to reply for
• s_type (integer) – s_type of rejected message
• reason (integer) – reason for rejection

send_separate_req()

Send a Separate Request to the remote host.