DoorControl

class hive.implementation.abstract_task.DoorControl(task: AbstractSequenceTask)

Bases: object

door devices control

Attributes Summary

DOOR_FORBIDDEN_PERIOD

devices

IDs of used door devices

Methods Summary

dequeue()

consume pending door commands.

is_empty()

is command pending queue empty?

reset(use_device)

reset door device list

set_door(device[, state, update, key_action])

set door state.

Attributes Documentation

DOOR_FORBIDDEN_PERIOD = 4
devices

IDs of used door devices

Methods Documentation

dequeue()

consume pending door commands. called by _check_routine

is_empty() bool

is command pending queue empty?

reset(use_device: List[str])

reset door device list

Parameters

use_device – door device name list

set_door(device: Union[None, str, List[str]], state=False, *, update=False, key_action=False)

set door state.

Parameters
  • device – door device. could be the device ID, list of device ID, or None for all

  • state – door open or close

  • update – update the last change time, no matter the state of the door had been changed

  • key_action – does this setting a key action? which means this action must be done and are unable to be overwrote by following commands.