Skip to content

Sensor system monitoring

Module contains a guidance sensor for tracking the "system monitoring" task acceptability, see SystemMonitoringTaskAcceptabilitySensor documentation for details.

SystemMonitoringTaskAcceptabilitySensor

Bases: TaskAcceptabilitySensor

Guidance sensor for the system monitoring task.

This sensor tracks a number of sub-tasks:

  • "system_monitoring.light-1"
  • "system_monitoring.light-2"
  • "system_monitoring.slider-1"
  • "system_monitoring.slider-2"
  • "system_monitoring.slider-3"
  • "system_monitoring.slider-4"

The acceptability of these sub-tasks can be checked by calling the methods:

  • SystemMonitoringTaskAcceptabilitySensor.is_light_acceptable
  • SystemMonitoringTaskAcceptabilitySensor.is_slider_acceptable

Otherwise follow the icua.agent.TaskAcceptabilitySensor API.

Source code in matbii\guidance\sensor_system_monitoring.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
class SystemMonitoringTaskAcceptabilitySensor(TaskAcceptabilitySensor):
    """Guidance sensor for the system monitoring task.

    This sensor tracks a number of sub-tasks:

    - `"system_monitoring.light-1"`
    - `"system_monitoring.light-2"`
    - `"system_monitoring.slider-1"`
    - `"system_monitoring.slider-2"`
    - `"system_monitoring.slider-3"`
    - `"system_monitoring.slider-4"`

    The acceptability of these sub-tasks can be checked by calling the methods:

    - `SystemMonitoringTaskAcceptabilitySensor.is_light_acceptable`
    - `SystemMonitoringTaskAcceptabilitySensor.is_slider_acceptable`

    Otherwise follow the `icua.agent.TaskAcceptabilitySensor` API.
    """

    def __init__(self, *args: list[Any], **kwargs: dict[str, Any]):
        """Constructor.

        Args:
            args (list[Any], optional): additional optional arguments.
            kwargs (dict[Any], optional): additional optional keyword arguments.
        """
        super().__init__(TASK_ID_SYSTEM_MONITORING, *args, **kwargs)
        self._is_subtask_acceptable = {
            f"{self.task_name}.light-1": partial(self.is_light_acceptable, 1),
            f"{self.task_name}.light-2": partial(self.is_light_acceptable, 2),
            f"{self.task_name}.slider-1": partial(self.is_slider_acceptable, 1),
            f"{self.task_name}.slider-2": partial(self.is_slider_acceptable, 2),
            f"{self.task_name}.slider-3": partial(self.is_slider_acceptable, 3),
            f"{self.task_name}.slider-4": partial(self.is_slider_acceptable, 4),
        }

    def is_acceptable(self, task: str = None, **kwargs: dict[str, Any]) -> bool:  # noqa
        if not self._is_active:
            return False  # always return False if the task is inactive
        if task is None or task == self.task_name:
            return all([x() for x in self._is_subtask_acceptable.values()])
        else:
            is_acceptable = self._is_subtask_acceptable.get(task, None)
            if is_acceptable is None:
                raise KeyError(
                    f"Invalid subtask: {task}, doesn't exist for task {self.task_name}"
                )
            else:
                return is_acceptable()

    def is_slider_acceptable(self, _id: int) -> bool:
        """Whether the given slider is in an acceptable state.

        Acceptable: the slider is at the central position.
        Unacceptable: otherwise.

        Args:
            _id (int): the id of the slider (1, 2, 3 or 4)

        Returns:
            bool: True if the slider is in an acceptable state, False otherwise.
        """
        if not self._is_active:
            return False  # always return False if the task is inactive
        # sliders should be at the center position to be acceptable
        state = self.beliefs[slider_id(_id)]["data-state"]
        acceptable_state = SetSliderAction.acceptable_state(
            self.beliefs[slider_incs_id(_id)]["incs"]
        )
        return state == acceptable_state

    def is_light_acceptable(self, _id: int) -> bool:
        """Whether the given light is in an acceptable state.

        Acceptable: light-1 is on, light-2 is off.
        Unacceptable: otherwise.

        Args:
            _id (int): the id of the light (1 or 2)

        Returns:
            bool: True if the light is in an acceptable state, False otherwise.
        """
        if not self._is_active:
            return False  # always return False if the task is inactive
        return [self._is_light1_acceptable, self._is_light2_acceptable][_id - 1]()

    def _is_light1_acceptable(self):
        # light 1 should be on
        return self.beliefs[light_id(1)]["data-state"] == SetLightAction.ON

    def _is_light2_acceptable(self):
        # light 2 should be off
        return self.beliefs[light_id(2)]["data-state"] == SetLightAction.OFF

    def sense(self) -> list[Select]:
        """Generates the sense actions that are required for checking whether the system monitoring task is in an acceptable state.

        The actions will request the following data:
        - the state of each light element.
        - the state of each slider element.
        - the number of increments in each slider element.

        Returns:
            list[Select]: list of sense actions to take.
        """
        # take these actions if this task is active
        lights = [f"//*[@id='{light_id(i)}']" for i in (1, 2)]
        sliders = [f"//*[@id='{slider_id(i)}']" for i in (1, 2, 3, 4)]
        slider_incs = [f"//*[@id='{slider_incs_id(i)}']" for i in (1, 2, 3, 4)]

        lights = [Select(xpath=xpath, attrs=["id", "data-state"]) for xpath in lights]
        sliders = [Select(xpath=xpath, attrs=["id", "data-state"]) for xpath in sliders]
        slider_incs = [
            Select(xpath=xpath, attrs=["id", "incs"]) for xpath in slider_incs
        ]
        return [*lights, *sliders, *slider_incs]

__init__(*args, **kwargs)

Constructor.

Parameters:

Name Type Description Default
args list[Any]

additional optional arguments.

 ()
kwargs dict[Any]

additional optional keyword arguments.

 {}
Source code in matbii\guidance\sensor_system_monitoring.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def __init__(self, *args: list[Any], **kwargs: dict[str, Any]):
    """Constructor.

    Args:
        args (list[Any], optional): additional optional arguments.
        kwargs (dict[Any], optional): additional optional keyword arguments.
    """
    super().__init__(TASK_ID_SYSTEM_MONITORING, *args, **kwargs)
    self._is_subtask_acceptable = {
        f"{self.task_name}.light-1": partial(self.is_light_acceptable, 1),
        f"{self.task_name}.light-2": partial(self.is_light_acceptable, 2),
        f"{self.task_name}.slider-1": partial(self.is_slider_acceptable, 1),
        f"{self.task_name}.slider-2": partial(self.is_slider_acceptable, 2),
        f"{self.task_name}.slider-3": partial(self.is_slider_acceptable, 3),
        f"{self.task_name}.slider-4": partial(self.is_slider_acceptable, 4),
    }

is_light_acceptable(_id)

Whether the given light is in an acceptable state.

Acceptable: light-1 is on, light-2 is off. Unacceptable: otherwise.

Parameters:

Name Type Description Default
_id int

the id of the light (1 or 2)

 required

Returns:

Name Type Description
bool bool

True if the light is in an acceptable state, False otherwise.
Source code in matbii\guidance\sensor_system_monitoring.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def is_light_acceptable(self, _id: int) -> bool:
    """Whether the given light is in an acceptable state.

    Acceptable: light-1 is on, light-2 is off.
    Unacceptable: otherwise.

    Args:
        _id (int): the id of the light (1 or 2)

    Returns:
        bool: True if the light is in an acceptable state, False otherwise.
    """
    if not self._is_active:
        return False  # always return False if the task is inactive
    return [self._is_light1_acceptable, self._is_light2_acceptable][_id - 1]()

is_slider_acceptable(_id)

Whether the given slider is in an acceptable state.

Acceptable: the slider is at the central position. Unacceptable: otherwise.

Parameters:

Name Type Description Default
_id int

the id of the slider (1, 2, 3 or 4)

 required

Returns:

Name Type Description
bool bool

True if the slider is in an acceptable state, False otherwise.
Source code in matbii\guidance\sensor_system_monitoring.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def is_slider_acceptable(self, _id: int) -> bool:
    """Whether the given slider is in an acceptable state.

    Acceptable: the slider is at the central position.
    Unacceptable: otherwise.

    Args:
        _id (int): the id of the slider (1, 2, 3 or 4)

    Returns:
        bool: True if the slider is in an acceptable state, False otherwise.
    """
    if not self._is_active:
        return False  # always return False if the task is inactive
    # sliders should be at the center position to be acceptable
    state = self.beliefs[slider_id(_id)]["data-state"]
    acceptable_state = SetSliderAction.acceptable_state(
        self.beliefs[slider_incs_id(_id)]["incs"]
    )
    return state == acceptable_state

sense()

Generates the sense actions that are required for checking whether the system monitoring task is in an acceptable state.

The actions will request the following data: - the state of each light element. - the state of each slider element. - the number of increments in each slider element.

Returns:

Type Description
list[Select]

list[Select]: list of sense actions to take.
Source code in matbii\guidance\sensor_system_monitoring.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def sense(self) -> list[Select]:
    """Generates the sense actions that are required for checking whether the system monitoring task is in an acceptable state.

    The actions will request the following data:
    - the state of each light element.
    - the state of each slider element.
    - the number of increments in each slider element.

    Returns:
        list[Select]: list of sense actions to take.
    """
    # take these actions if this task is active
    lights = [f"//*[@id='{light_id(i)}']" for i in (1, 2)]
    sliders = [f"//*[@id='{slider_id(i)}']" for i in (1, 2, 3, 4)]
    slider_incs = [f"//*[@id='{slider_incs_id(i)}']" for i in (1, 2, 3, 4)]

    lights = [Select(xpath=xpath, attrs=["id", "data-state"]) for xpath in lights]
    sliders = [Select(xpath=xpath, attrs=["id", "data-state"]) for xpath in sliders]
    slider_incs = [
        Select(xpath=xpath, attrs=["id", "incs"]) for xpath in slider_incs
    ]
    return [*lights, *sliders, *slider_incs]