class HsmsHandler(EventProducer):
"""Baseclass for creating Host/Equipment models. This layer contains the HSMS functionality. Inherit from this class and override required functions.
:param address: IP address of remote host
:type address: string
:param port: TCP port of remote host
:type port: integer
:param active: Is the connection active (*True*) or passive (*False*)
:type active: boolean
:param session_id: session / device ID to use for connection
:type session_id: integer
:param name: Name of the underlying configuration
:type name: string
:param event_handler: object for event handling
:type event_handler: :class:`secsgem.common.EventHandler`
:param custom_connection_handler: object for connection handling (ie multi server)
:type custom_connection_handler: :class:`secsgem.hsms.connections.HsmsMultiPassiveServer`
**Example**::
import secsgem
def onConnect(event, data):
print "Connected"
client = secsgem.HsmsHandler("10.211.55.33", 5000, True, 0, "test", event_handler=secsgem.EventHandler(events={'hsms_connected': onConnect}))
client.enable()
time.sleep(3)
client.disable()
"""
def __init__(self, address, port, active, session_id, name, event_handler=None, custom_connection_handler=None):
EventProducer.__init__(self, event_handler)
self.logger = logging.getLogger(self.__module__ + "." + self.__class__.__name__)
self.address = address
self.port = port
self.active = active
self.sessionID = session_id
self.name = name
self.connected = False
# system id counter
self.systemCounter = random.randint(0, (2 ** 32) - 1)
# repeating linktest variables
self.linktestTimer = None
self.linktestTimeout = 30
# response queues
self._systemQueues = {}
# hsms connection state fsm
self.connectionState = Fysom({
'initial': 'NOT_CONNECTED',
'events': [
{'name': 'connect', 'src': 'NOT_CONNECTED', 'dst': 'CONNECTED'},
{'name': 'disconnect', 'src': ['CONNECTED', 'NOT_SELECTED', 'SELECTED'], 'dst': 'NOT_CONNECTED'},
{'name': 'select', 'src': ['CONNECTED', 'NOT_SELECTED'], 'dst': 'SELECTED'},
{'name': 'deselect', 'src': 'SELECTED', 'dst': 'NOT_SELECTED'},
{'name': 'timeoutT7', 'src': ['CONNECTED', 'NOT_SELECTED'], 'dst': 'NOT_CONNECTED'},
],
'callbacks': {
'onNOT_SELECTED': self._on_state_connect,
'onNOT_CONNECTED': self._on_state_disconnect,
'onSELECTED': self._on_state_select,
},
'autoforward': [
{'src': 'CONNECTED', 'dst': 'NOT_SELECTED'}
]
})
# setup connection
if self.active:
if custom_connection_handler is None:
self.connection = HsmsActiveConnection(self.address, self.port, self.sessionID, self)
else:
self.connection = custom_connection_handler.create_connection(self.address, self.port, self.sessionID, self)
else:
if custom_connection_handler is None:
self.connection = HsmsPassiveConnection(self.address, self.port, self.sessionID, self)
else:
self.connection = custom_connection_handler.create_connection(self.address, self.port, self.sessionID, self)
def get_next_system_counter(self):
"""Returns the next System.
:returns: System for the next command
:rtype: integer
"""
self.systemCounter += 1
if self.systemCounter > ((2 ** 32) - 1):
self.systemCounter = 0
return self.systemCounter
def _on_state_connect(self, _):
"""Connection state model got event connect
:param data: event attributes
:type data: object
"""
# start linktest timer
self.linktestTimer = threading.Timer(self.linktestTimeout, self._on_linktest_timer)
self.linktestTimer.start()
# start select process if connection is active
if self.active:
response = self.send_select_req()
if response is None:
self.logger.warning("select request failed")
def _on_state_disconnect(self, _):
"""Connection state model got event disconnect
:param data: event attributes
:type data: object
"""
# stop linktest timer
if self.linktestTimer:
self.linktestTimer.cancel()
self.linktestTimer = None
def _on_state_select(self, _):
"""Connection state model got event select
:param data: event attributes
:type data: object
"""
# send event
self.fire_event('hsms_selected', {'connection': self})
# notify hsms handler of selection
if hasattr(self, '_on_hsms_select') and callable(getattr(self, '_on_hsms_select')):
self._on_hsms_select()
def _on_linktest_timer(self):
"""Linktest time timed out, so send linktest request"""
# send linktest request and wait for response
self.send_linktest_req()
# restart the timer
self.linktestTimer = threading.Timer(self.linktestTimeout, self._on_linktest_timer)
self.linktestTimer.start()
def on_connection_established(self, _):
"""Connection was established"""
self.connected = True
# update connection state
self.connectionState.connect()
self.fire_event("hsms_connected", {'connection': self})
def on_connection_before_closed(self, _):
"""Connection is about to be closed"""
# send separate request
self.send_separate_req()
def on_connection_closed(self, _):
"""Connection was closed"""
# update connection state
self.connected = False
self.connectionState.disconnect()
self.fire_event("hsms_disconnected", {'connection': self})
def on_connection_packet_received(self, _, packet):
"""Packet received by connection
:param packet: received data packet
:type packet: :class:`secsgem.hsms.packets.HsmsPacket`
"""
# if packet.header.system > self.systemCounter or packet.header.system == 0:
# self.systemCounter = packet.header.system
if packet.header.sType > 0:
self.logger.info("< %s\n %s", packet, hsmsSTypes[packet.header.sType])
# check if it is a select request
if packet.header.sType == 0x01:
# if we are disconnecting send reject else send response
if self.connection.disconnecting:
self.send_reject_rsp(packet.header.system, packet.header.sType, 4)
else:
self.send_select_rsp(packet.header.system)
# update connection state
self.connectionState.select()
# check if it is a select response
elif packet.header.sType == 0x02:
# update connection state
self.connectionState.select()
if packet.header.system in self._systemQueues:
# send packet to request sender
self._systemQueues[packet.header.system].put_nowait(packet)
# what to do if no sender for request waiting?
# check if it is a deselect request
elif packet.header.sType == 0x03:
# if we are disconnecting send reject else send response
if self.connection.disconnecting:
self.send_reject_rsp(packet.header.system, packet.header.sType, 4)
else:
self.send_deselect_rsp(packet.header.system)
# update connection state
self.connectionState.deselect()
# check if it is a deselect response
elif packet.header.sType == 0x04:
# update connection state
self.connectionState.deselect()
if packet.header.system in self._systemQueues:
# send packet to request sender
self._systemQueues[packet.header.system].put_nowait(packet)
# what to do if no sender for request waiting?
# check if it is a linktest request
elif packet.header.sType == 0x05:
# if we are disconnecting send reject else send response
if self.connection.disconnecting:
self.send_reject_rsp(packet.header.system, packet.header.sType, 4)
else:
self.send_linktest_rsp(packet.header.system)
else:
if packet.header.system in self._systemQueues:
# send packet to request sender
self._systemQueues[packet.header.system].put_nowait(packet)
# what to do if no sender for request waiting?
else:
if not self.connectionState.isstate("SELECTED"):
self.logger.info("< %s", packet)
self.logger.warning("received message when not selected")
self.connection.send_packet(HsmsPacket(HsmsRejectReqHeader(packet.header.system, packet.header.sType, 4)))
return True
# someone is waiting for this message
if packet.header.system in self._systemQueues:
# send packet to request sender
self._systemQueues[packet.header.system].put_nowait(packet)
# redirect packet to hsms handler
elif hasattr(self, '_on_hsms_packet_received') and callable(getattr(self, '_on_hsms_packet_received')):
self._on_hsms_packet_received(packet)
# just log if nobody is interested
else:
self.logger.info("< %s", packet)
def _get_queue_for_system(self, system_id):
"""Creates a new queue to receive responses for a certain system
:param system_id: system id to watch
:type system_id: int
:returns: queue to receive responses with
:rtype: Queue.Queue
"""
self._systemQueues[system_id] = Queue.Queue()
return self._systemQueues[system_id]
def _remove_queue(self, system_id):
"""Remove queue for system id from list
:param system_id: system id to remove
:type system_id: int
"""
del self._systemQueues[system_id]
def _serialize_data(self):
"""Returns data for serialization
:returns: data to serialize for this object
:rtype: dict
"""
return {'address': self.address, 'port': self.port, 'active': self.active, 'sessionID': self.sessionID, 'name': self.name, 'connected': self.connected}
def enable(self):
"""Enables the connection"""
self.connection.enable()
def disable(self):
"""Disables the connection"""
self.connection.disable()
def send_stream_function(self, packet):
"""Send the packet and wait for the response
:param packet: packet to be sent
:type packet: :class:`secsgem.secs.functionbase.SecsStreamFunction`
"""
out_packet = HsmsPacket(HsmsStreamFunctionHeader(self.get_next_system_counter(), packet.stream, packet.function, True, self.sessionID), packet.encode())
self.connection.send_packet(out_packet)
def send_and_waitfor_response(self, packet):
"""Send the packet and wait for the response
:param packet: packet to be sent
:type packet: :class:`secsgem.secs.functionbase.SecsStreamFunction`
:returns: Packet that was received
:rtype: :class:`secsgem.hsms.packets.HsmsPacket`
"""
system_id = self.get_next_system_counter()
response_queue = self._get_queue_for_system(system_id)
out_packet = HsmsPacket(HsmsStreamFunctionHeader(system_id, packet.stream, packet.function, True, self.sessionID), packet.encode())
self.connection.send_packet(out_packet)
try:
response = response_queue.get(True, self.connection.T3)
except Queue.Empty:
response = None
self._remove_queue(system_id)
return response
def send_response(self, function, system):
"""Send response function for system
:param function: function to be sent
:type function: :class:`secsgem.secs.functionbase.SecsStreamFunction`
:param system: system to reply to
:type system: integer
"""
out_packet = HsmsPacket(HsmsStreamFunctionHeader(system, function.stream, function.function, False, self.sessionID), function.encode())
self.connection.send_packet(out_packet)
def send_select_req(self):
"""Send a Select Request to the remote host
:returns: System of the sent request
:rtype: integer
"""
system_id = self.get_next_system_counter()
response_queue = self._get_queue_for_system(system_id)
packet = HsmsPacket(HsmsSelectReqHeader(system_id))
self.connection.send_packet(packet)
try:
response = response_queue.get(True, self.connection.T6)
except Queue.Empty:
response = None
self._remove_queue(system_id)
return response
def send_select_rsp(self, system_id):
"""Send a Select Response to the remote host
:param system_id: System of the request to reply for
:type system_id: integer
"""
packet = HsmsPacket(HsmsSelectRspHeader(system_id))
self.connection.send_packet(packet)
def send_linktest_req(self):
"""Send a Linktest Request to the remote host
:returns: System of the sent request
:rtype: integer
"""
system_id = self.get_next_system_counter()
response_queue = self._get_queue_for_system(system_id)
packet = HsmsPacket(HsmsLinktestReqHeader(system_id))
self.connection.send_packet(packet)
try:
response = response_queue.get(True, self.connection.T6)
except Queue.Empty:
response = None
self._remove_queue(system_id)
return response
def send_linktest_rsp(self, system_id):
"""Send a Linktest Response to the remote host
:param system_id: System of the request to reply for
:type system_id: integer
"""
packet = HsmsPacket(HsmsLinktestRspHeader(system_id))
self.connection.send_packet(packet)
def send_deselect_req(self):
"""Send a Deselect Request to the remote host
:returns: System of the sent request
:rtype: integer
"""
system_id = self.get_next_system_counter()
response_queue = self._get_queue_for_system(system_id)
packet = HsmsPacket(HsmsDeselectReqHeader(system_id))
self.connection.send_packet(packet)
try:
response = response_queue.get(True, self.connection.T6)
except Queue.Empty:
response = None
self._remove_queue(system_id)
return response
def send_deselect_rsp(self, system_id):
"""Send a Deselect Response to the remote host
:param system_id: System of the request to reply for
:type system_id: integer
"""
packet = HsmsPacket(HsmsDeselectRspHeader(system_id))
self.connection.send_packet(packet)
def send_reject_rsp(self, system_id, s_type, reason):
"""Send a Reject Response to the remote host
:param system_id: System of the request to reply for
:type system_id: integer
:param s_type: s_type of rejected message
:type s_type: integer
:param reason: reason for rejection
:type reason: integer
"""
packet = HsmsPacket(HsmsRejectReqHeader(system_id, s_type, reason))
self.connection.send_packet(packet)
def send_separate_req(self):
"""Send a Separate Request to the remote host"""
system_id = self.get_next_system_counter()
packet = HsmsPacket(HsmsSeparateReqHeader(system_id))
self.connection.send_packet(packet)
return system_id
class GemHandler(SecsHandler):
"""Baseclass for creating Host/Equipment models. This layer contains GEM functionality. Inherit from this class and override required functions.
:param address: IP address of remote host
:type address: string
:param port: TCP port of remote host
:type port: integer
:param active: Is the connection active (*True*) or passive (*False*)
:type active: boolean
:param session_id: session / device ID to use for connection
:type session_id: integer
:param name: Name of the underlying configuration
:type name: string
:param event_handler: object for event handling
:type event_handler: :class:`secsgem.common.EventHandler`
:param custom_connection_handler: object for connection handling (ie multi server)
:type custom_connection_handler: :class:`secsgem.hsms.connections.HsmsMultiPassiveServer`
"""
def __init__(self, address, port, active, session_id, name, event_handler=None, custom_connection_handler=None):
SecsHandler.__init__(self, address, port, active, session_id, name, event_handler, custom_connection_handler)
self.logger = logging.getLogger(self.__module__ + "." + self.__class__.__name__)
self.isHost = True
# not going to HOST_INITIATED_CONNECT because fysom doesn't support two states. but there is a transistion to get out of EQUIPMENT_INITIATED_CONNECT when the HOST_INITIATED_CONNECT happens
self.communicationState = Fysom({
'initial': 'DISABLED', # 1
'events': [
{'name': 'enable', 'src': 'DISABLED', 'dst': 'ENABLED'}, # 2
{'name': 'disable', 'src': ['ENABLED', 'NOT_COMMUNICATING', 'COMMUNICATING', 'EQUIPMENT_INITIATED_CONNECT', 'WAIT_DELAY', 'WAIT_CRA', "HOST_INITIATED_CONNECT", "WAIT_CR_FROM_HOST"], 'dst': 'DISABLED'}, # 3
{'name': 'select', 'src': 'NOT_COMMUNICATING', 'dst': 'EQUIPMENT_INITIATED_CONNECT'}, # 5
{'name': 'communicationreqfail', 'src': 'WAIT_CRA', 'dst': 'WAIT_DELAY'}, # 6
{'name': 'delayexpired', 'src': 'WAIT_DELAY', 'dst': 'WAIT_CRA'}, # 7
{'name': 'messagereceived', 'src': 'WAIT_DELAY', 'dst': 'WAIT_CRA'}, # 8
{'name': 's1f14received', 'src': 'WAIT_CRA', 'dst': 'COMMUNICATING'}, # 9
{'name': 'communicationfail', 'src': 'COMMUNICATING', 'dst': 'NOT_COMMUNICATING'}, # 14
{'name': 's1f13received', 'src': ['WAIT_CR_FROM_HOST', 'WAIT_DELAY', 'WAIT_CRA'], 'dst': 'COMMUNICATING'}, # 15 (WAIT_CR_FROM_HOST is running in background - AND state - so if s1f13 is received we go all communicating)
],
'callbacks': {
'onWAIT_CRA': self._on_state_wait_cra,
'onWAIT_DELAY': self._on_state_wait_delay,
'onleaveWAIT_CRA': self._on_state_leave_wait_cra,
'onleaveWAIT_DELAY': self._on_state_leave_wait_delay,
'onCOMMUNICATING': self._on_state_communicating,
# 'onselect': self.onStateSelect,
},
'autoforward': [
{'src': 'ENABLED', 'dst': 'NOT_COMMUNICATING'}, # 4
{'src': 'EQUIPMENT_INITIATED_CONNECT', 'dst': 'WAIT_CRA'}, # 5
{'src': 'HOST_INITIATED_CONNECT', 'dst': 'WAIT_CR_FROM_HOST'}, # 10
]
})
self.waitCRATimer = None
self.commDelayTimer = None
self.commDelayTimeout = 10
self.reportIDCounter = 1000
self.waitEventList = []
self.register_callback(1, 1, self.s01f01_handler)
self.register_callback(1, 13, self.s01f13_handler)
def _serialize_data(self):
"""Returns data for serialization
:returns: data to serialize for this object
:rtype: dict
"""
data = SecsHandler._serialize_data(self)
data.update({'communicationState': self.communicationState.current, 'commDelayTimeout': self.commDelayTimeout, 'reportIDCounter': self.reportIDCounter})
return data
def enable(self):
"""Enables the connection"""
self.connection.enable()
self.communicationState.enable()
self.logger.info("Connection enabled")
def disable(self):
"""Disables the connection"""
self.connection.disable()
self.communicationState.disable()
self.logger.info("Connection disabled")
def _on_hsms_packet_received(self, packet):
"""Packet received from hsms layer
:param packet: received data packet
:type packet: :class:`secsgem.HsmsPacket`
"""
message = self.secs_decode(packet)
if message is None:
self.logger.info("< %s", packet)
else:
self.logger.info("< %s\n%s", packet, message)
if self.communicationState.isstate('WAIT_CRA'):
if packet.header.stream == 1 and packet.header.function == 13:
if self.isHost:
self.send_response(self.stream_function(1, 14)({"COMMACK": 1, "DATA": []}), packet.header.system)
else:
self.send_response(self.stream_function(1, 14)({"COMMACK": 1, "DATA": ["secsgem", "0.0.3"]}), packet.header.system)
self.communicationState.s1f13received()
elif packet.header.stream == 1 and packet.header.function == 14:
self.communicationState.s1f14received()
elif self.communicationState.isstate('WAIT_DELAY'):
pass
elif self.communicationState.isstate('COMMUNICATING'):
# check if callbacks available for this stream and function
callback_index = "s" + str(packet.header.stream) + "f" + str(packet.header.function)
if callback_index in self.callbacks:
threading.Thread(target=self._run_callbacks, args=(callback_index, packet), name="secsgem_gemHandler_callback_{}".format(callback_index)).start()
else:
self.logger.warning("unexpected function received %s\n%s", callback_index, packet.header)
if packet.header.requireResponse:
self.send_response(SecsS09F05(packet.header.encode()), packet.header.system)
def _on_hsms_select(self):
"""Selected received from hsms layer"""
self.communicationState.select()
def _on_wait_cra_timeout(self):
"""Linktest time timed out, so send linktest request"""
self.communicationState.communicationreqfail()
def _on_wait_comm_delay_timeout(self):
"""Linktest time timed out, so send linktest request"""
self.communicationState.delayexpired()
def _on_state_wait_cra(self, _):
"""Connection state model changed to state WAIT_CRA
:param data: event attributes
:type data: object
"""
self.logger.debug("connectionState -> WAIT_CRA")
self.waitCRATimer = threading.Timer(self.connection.T3, self._on_wait_cra_timeout)
self.waitCRATimer.start()
if self.isHost:
self.send_stream_function(self.stream_function(1, 13)())
else:
self.send_stream_function(self.stream_function(1, 13)(["secsgem", "0.0.3"]))
def _on_state_wait_delay(self, _):
"""Connection state model changed to state WAIT_DELAY
:param data: event attributes
:type data: object
"""
self.logger.debug("connectionState -> WAIT_DELAY")
self.commDelayTimer = threading.Timer(self.commDelayTimeout, self._on_wait_comm_delay_timeout)
self.commDelayTimer.start()
def _on_state_leave_wait_cra(self, _):
"""Connection state model changed to state WAIT_CRA
:param data: event attributes
:type data: object
"""
if self.waitCRATimer is not None:
self.waitCRATimer.cancel()
def _on_state_leave_wait_delay(self, _):
"""Connection state model changed to state WAIT_DELAY
:param data: event attributes
:type data: object
"""
if self.commDelayTimer is not None:
self.commDelayTimer.cancel()
def _on_state_communicating(self, _):
"""Connection state model changed to state COMMUNICATING
:param data: event attributes
:type data: object
"""
self.logger.debug("connectionState -> COMMUNICATING")
self.fire_event("handler_communicating", {'handler': self}, True)
for event in self.waitEventList:
event.set()
def on_connection_closed(self, connection):
"""Connection was closed"""
self.logger.info("Connection was closed")
# call parent handlers
SecsHandler.on_connection_closed(self, connection)
# update communication state
self.communicationState.communicationfail()
def send_remote_command(self, rcmd, params):
"""Send a remote command
:param rcmd: Name of command
:type rcmd: string
:param params: DV IDs to add for collection event
:type params: list of strings
"""
self.logger.info("Send RCMD {0}".format(rcmd))
s2f41 = self.stream_function(2, 41)()
s2f41.RCMD = rcmd
for param in params:
s2f41.PARAMS.append({"CPNAME": param[0], "CPVAL": param[1]})
# send remote command
return self.secs_decode(self.send_and_waitfor_response(s2f41))
def send_process_program(self, ppid, ppbody):
"""Send a process program
:param ppid: Transferred process programs ID
:type ppid: string
:param ppbody: Content of process program
:type ppbody: string
"""
# send remote command
self.logger.info("Send process program {0}".format(ppid))
return self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 3)({"ppid": ppid, "ppbody": ppbody}))).ACKC7
def request_process_program(self, ppid):
"""Request a process program
:param ppid: Transferred process programs ID
:type ppid: string
"""
self.logger.info("Request process program {0}".format(ppid))
# send remote command
s7f6 = self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 5)(ppid)))
return s7f6.PPID, s7f6.PPBODY
def delete_process_programs(self, ppids):
"""Delete a list of process program
:param ppids: Process programs to delete
:type ppids: list of strings
"""
self.logger.info("Delete process programs {0}".format(ppids))
# send remote command
return self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 17)(ppids))).ACKC7
def get_process_program_list(self):
"""Get process program list
"""
self.logger.info("Get process program list")
# send remote command
return self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 19)())).get()
def waitfor_communicating(self, timeout=None):
"""Wait until connection gets into communicating state. Returns immediately if state is communicating
:param timeout: seconds to wait before aborting
:type timeout: float
:returns: True if state is communicating, False if timed out
:rtype: bool
"""
event = threading.Event()
self.waitEventList.append(event)
if self.communicationState.isstate("COMMUNICATING"):
self.waitEventList.remove(event)
return True
result = event.wait(timeout)
self.waitEventList.remove(event)
return result
def s01f01_handler(self, handler, packet):
"""Callback handler for Stream 1, Function 1, Are You There
.. seealso:: :func:`secsgem.common.StreamFunctionCallbackHandler.register_callback`
:param handler: handler the message was received on
:type handler: :class:`secsgem.hsms.handler.HsmsHandler`
:param packet: complete message received
:type packet: :class:`secsgem.hsms.packets.HsmsPacket`
"""
handler.send_response(self.stream_function(1, 2)(), packet.header.system)
def s01f13_handler(self, handler, packet):
"""Callback handler for Stream 1, Function 13, Establish Communication Request
.. seealso:: :func:`secsgem.common.StreamFunctionCallbackHandler.register_callback`
:param handler: handler the message was received on
:type handler: :class:`secsgem.hsms.handler.HsmsHandler`
:param packet: complete message received
:type packet: :class:`secsgem.hsms.packets.HsmsPacket`
"""
handler.send_response(self.stream_function(1, 14)({"COMMACK": 0}), packet.header.system)
class GemHandler(SecsHandler):
"""Baseclass for creating Host/Equipment models. This layer contains GEM functionality. Inherit from this class and override required functions.
:param address: IP address of remote host
:type address: string
:param port: TCP port of remote host
:type port: integer
:param active: Is the connection active (*True*) or passive (*False*)
:type active: boolean
:param session_id: session / device ID to use for connection
:type session_id: integer
:param name: Name of the underlying configuration
:type name: string
:param event_handler: object for event handling
:type event_handler: :class:`secsgem.common.EventHandler`
:param custom_connection_handler: object for connection handling (ie multi server)
:type custom_connection_handler: :class:`secsgem.hsms.connections.HsmsMultiPassiveServer`
"""
ceids = SecsHandler.ceids
"""Dictionary of available collection events, CEID is the key
:param name: Name of the data value
:type name: string
:param CEID: Collection event the data value is used for
:type CEID: integer
"""
dvs = SecsHandler.dvs
"""Dictionary of available data values, DVID is the key
:param name: Name of the collection event
:type name: string
:param dv: Data values available for collection event
:type dv: list of integers
"""
alarms = SecsHandler.alarms
"""Dictionary of available alarms, ALID is the key
:param alarmText: Description of the alarm
:type alarmText: string
:param ceidOn: Collection event for activated alarm
:type ceidOn: integer
:param ceidOff: Collection event for deactivated alarm
:type ceidOff: integer
"""
rcmds = SecsHandler.rcmds
"""Dictionary of available remote commands, command is the key
:param params: description of the parameters
:type params: list of dictionary
:param CEID: Collection events the remote command uses
:type CEID: list of integers
"""
def __init__(self, address, port, active, session_id, name, event_handler=None, custom_connection_handler=None):
SecsHandler.__init__(self, address, port, active, session_id, name, event_handler, custom_connection_handler)
self.logger = logging.getLogger(self.__module__ + "." + self.__class__.__name__)
# not going to HOST_INITIATED_CONNECT because fysom doesn't support two states. but there is a transistion to get out of EQUIPMENT_INITIATED_CONNECT when the HOST_INITIATED_CONNECT happens
self.communicationState = Fysom({
'initial': 'DISABLED', # 1
'events': [
{'name': 'enable', 'src': 'DISABLED', 'dst': 'ENABLED'}, # 2
{'name': 'disable', 'src': ['ENABLED', 'NOT_COMMUNICATING', 'COMMUNICATING', 'EQUIPMENT_INITIATED_CONNECT', 'WAIT_DELAY', 'WAIT_CRA', "HOST_INITIATED_CONNECT", "WAIT_CR_FROM_HOST"], 'dst': 'DISABLED'}, # 3
{'name': 'select', 'src': 'NOT_COMMUNICATING', 'dst': 'EQUIPMENT_INITIATED_CONNECT'}, # 5
{'name': 'communicationreqfail', 'src': 'WAIT_CRA', 'dst': 'WAIT_DELAY'}, # 6
{'name': 'delayexpired', 'src': 'WAIT_DELAY', 'dst': 'WAIT_CRA'}, # 7
{'name': 'messagereceived', 'src': 'WAIT_DELAY', 'dst': 'WAIT_CRA'}, # 8
{'name': 's1f14received', 'src': 'WAIT_CRA', 'dst': 'COMMUNICATING'}, # 9
{'name': 'communicationfail', 'src': 'COMMUNICATING', 'dst': 'NOT_COMMUNICATING'}, # 14
{'name': 's1f13received', 'src': ['WAIT_CR_FROM_HOST', 'WAIT_DELAY', 'WAIT_CRA'], 'dst': 'COMMUNICATING'}, # 15 (WAIT_CR_FROM_HOST is running in background - AND state - so if s1f13 is received we go all communicating)
],
'callbacks': {
'onWAIT_CRA': self._on_state_wait_cra,
'onWAIT_DELAY': self._on_state_wait_delay,
'onleaveWAIT_CRA': self._on_state_leave_wait_cra,
'onleaveWAIT_DELAY': self._on_state_leave_wait_delay,
'onCOMMUNICATING': self._on_state_communicating,
# 'onselect': self.onStateSelect,
},
'autoforward': [
{'src': 'ENABLED', 'dst': 'NOT_COMMUNICATING'}, # 4
{'src': 'EQUIPMENT_INITIATED_CONNECT', 'dst': 'WAIT_CRA'}, # 5
{'src': 'HOST_INITIATED_CONNECT', 'dst': 'WAIT_CR_FROM_HOST'}, # 10
]
})
self.waitCRATimer = None
self.commDelayTimer = None
self.commDelayTimeout = 10
self.reportIDCounter = 1000
self.reportSubscriptions = {}
self.waitEventList = []
self.register_callback(1, 1, self.s01f01_handler)
self.register_callback(1, 13, self.s01f13_handler)
self.register_callback(6, 11, self.s06f11_handler)
self.register_callback(10, 1, self.s10f01_handler)
def _serialize_data(self):
"""Returns data for serialization
:returns: data to serialize for this object
:rtype: dict
"""
data = SecsHandler._serialize_data(self)
data.update({'communicationState': self.communicationState.current, 'commDelayTimeout': self.commDelayTimeout, 'reportIDCounter': self.reportIDCounter, 'reportSubscriptions': self.reportSubscriptions})
return data
def enable(self):
"""Enables the connection"""
self.connection.enable()
self.communicationState.enable()
self.logger.info("Connection enabled")
def disable(self):
"""Disables the connection"""
self.connection.disable()
self.communicationState.disable()
self.logger.info("Connection disabled")
def _on_hsms_packet_received(self, packet):
"""Packet received from hsms layer
:param packet: received data packet
:type packet: :class:`secsgem.HsmsPacket`
"""
message = self.secs_decode(packet)
if message is None:
self.logger.info("< %s", packet)
else:
self.logger.info("< %s\n%s", packet, message)
if self.communicationState.isstate('WAIT_CRA'):
if packet.header.stream == 1 and packet.header.function == 13:
if self.isHost:
self.send_stream_function(self.stream_function(1, 14)({"COMMACK": 1, "DATA": {}}))
else:
self.send_stream_function(self.stream_function(1, 14)({"COMMACK": 1, "DATA": {"MDLN": "secsgem", "SOFTREV": "0.0.3"}}))
self.communicationState.s1f13received()
elif packet.header.stream == 1 and packet.header.function == 14:
self.communicationState.s1f14received()
elif self.communicationState.isstate('WAIT_DELAY'):
pass
elif self.communicationState.isstate('COMMUNICATING'):
# check if callbacks available for this stream and function
callback_index = "s" + str(packet.header.stream) + "f" + str(packet.header.function)
if callback_index in self.callbacks:
threading.Thread(target=self._run_callbacks, args=(callback_index, packet), name="secsgem_gemHandler_callback_{}".format(callback_index)).start()
else:
self._queue_packet(packet)
def _on_hsms_select(self):
"""Selected received from hsms layer"""
self.communicationState.select()
def _on_wait_cra_timeout(self):
"""Linktest time timed out, so send linktest request"""
self.communicationState.communicationreqfail()
def _on_wait_comm_delay_timeout(self):
"""Linktest time timed out, so send linktest request"""
self.communicationState.delayexpired()
def _on_state_wait_cra(self, _):
"""Connection state model changed to state WAIT_CRA
:param data: event attributes
:type data: object
"""
self.logger.debug("connectionState -> WAIT_CRA")
self.waitCRATimer = threading.Timer(self.connection.T3, self._on_wait_cra_timeout)
self.waitCRATimer.start()
if self.isHost:
self.send_stream_function(self.stream_function(1, 13)())
else:
self.send_stream_function(self.stream_function(1, 13)("secsgem", "0.0.3"))
def _on_state_wait_delay(self, _):
"""Connection state model changed to state WAIT_DELAY
:param data: event attributes
:type data: object
"""
self.logger.debug("connectionState -> WAIT_DELAY")
self.commDelayTimer = threading.Timer(self.commDelayTimeout, self._on_wait_comm_delay_timeout)
self.commDelayTimer.start()
def _on_state_leave_wait_cra(self, _):
"""Connection state model changed to state WAIT_CRA
:param data: event attributes
:type data: object
"""
if self.waitCRATimer is not None:
self.waitCRATimer.cancel()
def _on_state_leave_wait_delay(self, _):
"""Connection state model changed to state WAIT_DELAY
:param data: event attributes
:type data: object
"""
if self.commDelayTimer is not None:
self.commDelayTimer.cancel()
def _on_state_communicating(self, _):
"""Connection state model changed to state COMMUNICATING
:param data: event attributes
:type data: object
"""
self.logger.debug("connectionState -> COMMUNICATING")
self.fire_event("handler_communicating", {'handler': self}, True)
for event in self.waitEventList:
event.set()
def on_connection_closed(self, connection):
"""Connection was closed"""
self.logger.info("Connection was closed")
# call parent handlers
SecsHandler.on_connection_closed(self, connection)
# update communication state
self.communicationState.communicationfail()
def clear_collection_events(self):
"""Clear all collection events"""
self.logger.info("Clearing collection events")
# clear subscribed reports
self.reportSubscriptions = {}
# disable all ceids
self.disable_ceids()
# delete all reports
self.disable_ceid_reports()
def subscribe_collection_event(self, ceid, dvs, report_id=None):
"""Subscribe to a collection event
:param ceid: ID of the collection event
:type ceid: integer
:param dvs: DV IDs to add for collection event
:type dvs: list of integers
:param report_id: optional - ID for report, autonumbering if None
:type report_id: integer
"""
self.logger.info("Subscribing to collection event {0}".format(ceid))
if report_id is None:
report_id = self.reportIDCounter
self.reportIDCounter += 1
# note subscribed reports
self.reportSubscriptions[report_id] = dvs
# create report
self.send_and_waitfor_response(self.stream_function(2, 33)({"DATAID": 0, "DATA": [{"RPTID": report_id, "VID": dvs}]}))
# link event report to collection event
self.send_and_waitfor_response(self.stream_function(2, 35)({"DATAID": 0, "DATA": [{"CEID": ceid, "RPTID": [report_id]}]}))
# enable collection event
self.send_and_waitfor_response(self.stream_function(2, 37)({"CEED": True, "CEID": [ceid]}))
def send_remote_command(self, rcmd, params):
"""Send a remote command
:param rcmd: Name of command
:type rcmd: string
:param params: DV IDs to add for collection event
:type params: list of strings
"""
self.logger.info("Send RCMD {0}".format(rcmd))
s2f41 = self.stream_function(2, 41)()
s2f41.RCMD = rcmd
for param in params:
s2f41.PARAMS.append({"CPNAME": param[0], "CPVAL": param[1]})
# send remote command
return self.secs_decode(self.send_and_waitfor_response(s2f41))
def send_process_program(self, ppid, ppbody):
"""Send a process program
:param ppid: Transferred process programs ID
:type ppid: string
:param ppbody: Content of process program
:type ppbody: string
"""
# send remote command
self.logger.info("Send process program {0}".format(ppid))
return self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 3)({"ppid": ppid, "ppbody": ppbody}))).ACKC7
def request_process_program(self, ppid):
"""Request a process program
:param ppid: Transferred process programs ID
:type ppid: string
"""
self.logger.info("Request process program {0}".format(ppid))
# send remote command
s7f6 = self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 5)(ppid)))
return s7f6.PPID, s7f6.PPBODY
def delete_process_programs(self, ppids):
"""Delete a list of process program
:param ppids: Process programs to delete
:type ppids: list of strings
"""
self.logger.info("Delete process programs {0}".format(ppids))
# send remote command
return self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 17)(ppids))).ACKC7
def get_process_program_list(self):
"""Get process program list
"""
self.logger.info("Get process program list")
# send remote command
return self.secs_decode(self.send_and_waitfor_response(self.stream_function(7, 19)())).get()
def waitfor_communicating(self, timeout=None):
"""Wait until connection gets into communicating state. Returns immediately if state is communicating
:param timeout: seconds to wait before aborting
:type timeout: float
:returns: True if state is communicating, False if timed out
:rtype: bool
"""
event = threading.Event()
self.waitEventList.append(event)
if self.communicationState.isstate("COMMUNICATING"):
self.waitEventList.remove(event)
return True
result = event.wait(timeout)
self.waitEventList.remove(event)
return result
def s01f01_handler(self, handler, packet):
"""Callback handler for Stream 1, Function 1, Are You There
.. seealso:: :func:`secsgem.common.StreamFunctionCallbackHandler.register_callback`
:param handler: handler the message was received on
:type handler: :class:`secsgem.hsms.handler.HsmsHandler`
:param packet: complete message received
:type packet: :class:`secsgem.hsms.packets.HsmsPacket`
"""
handler.send_response(self.stream_function(1, 2)(), packet.header.system)
def s01f13_handler(self, handler, packet):
"""Callback handler for Stream 1, Function 13, Establish Communication Request
.. seealso:: :func:`secsgem.common.StreamFunctionCallbackHandler.register_callback`
:param handler: handler the message was received on
:type handler: :class:`secsgem.hsms.handler.HsmsHandler`
:param packet: complete message received
:type packet: :class:`secsgem.hsms.packets.HsmsPacket`
"""
handler.send_response(self.stream_function(1, 14)({"COMMACK": 0}), packet.header.system)
def s06f11_handler(self, handler, packet):
"""Callback handler for Stream 6, Function 11, Establish Communication Request
.. seealso:: :func:`secsgem.common.StreamFunctionCallbackHandler.register_callback`
:param handler: handler the message was received on
:type handler: :class:`secsgem.hsms.handler.HsmsHandler`
:param packet: complete message received
:type packet: :class:`secsgem.hsms.packets.HsmsPacket`
"""
message = self.secs_decode(packet)
for report in message.RPT:
report_dvs = self.reportSubscriptions[report.RPTID]
report_values = report.V.get()
values = []
for i, s in enumerate(report_dvs):
values.append({"dvid": s, "value": report_values[i], "name": self.get_dvid_name(s)})
print values
data = {"ceid": message.CEID, "rptid": report.RPTID, "values": values, "name": self.get_ceid_name(message.CEID), "handler": self.connection, 'peer': self}
self.fire_event("collection_event_received", data)
handler.send_response(self.stream_function(6, 12)(0), packet.header.system)
def s10f01_handler(self, handler, packet):
"""Callback handler for Stream 10, Function 1, Terminal Request
.. seealso:: :func:`secsgem.common.StreamFunctionCallbackHandler.register_callback`
:param handler: handler the message was received on
:type handler: :class:`secsgem.hsms.handler.HsmsHandler`
:param packet: complete message received
:type packet: :class:`secsgem.hsms.packets.HsmsPacket`
"""
s10f1 = self.secs_decode(packet)
handler.send_response(self.stream_function(10, 2)(0), packet.header.system)
self.fire_event("terminal_received", {"text": s10f1.TEXT, "terminal": s10f1.TID, "handler": self.connection, 'peer': self})