| Matt Spinler | 45ed88d | 2020-11-20 11:33:16 -0600 | [diff] [blame] | 1 | description: > |
| 2 | |
| 3 | Implement to provide hard shutdown class sensor thresholds. Objects |
| 4 | implementing Sensor.Threshold.HardShutdown must be instantiated in the |
| 5 | correct hierarchy within the sensors namespace. The following sensor |
| 6 | hierarchies are recognized: |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 7 | airflow |
| Matt Spinler | 45ed88d | 2020-11-20 11:33:16 -0600 | [diff] [blame] | 8 | altitude |
| 9 | current |
| Matt Spinler | 45ed88d | 2020-11-20 11:33:16 -0600 | [diff] [blame] | 10 | energy |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 11 | fan_tach |
| Patrick Williams | 1bcf7fa | 2021-12-22 09:14:37 -0600 | [diff] [blame] | 12 | humidity |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 13 | power |
| Patrick Williams | 86f8c53 | 2021-10-01 06:34:04 -0500 | [diff] [blame] | 14 | pressure |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 15 | temperature |
| 16 | utilization |
| 17 | voltage |
| Matt Spinler | 45ed88d | 2020-11-20 11:33:16 -0600 | [diff] [blame] | 18 | |
| 19 | Additionally, any object implementing Sensor.Threshold.HardShutdown must |
| 20 | also implement Sensor.Value. |
| 21 | |
| 22 | properties: |
| 23 | - name: HardShutdownHigh |
| 24 | type: double |
| 25 | default: NaN |
| 26 | description: > |
| 27 | The upper bound of the shutdown threshold. A value of 'NaN' is used |
| 28 | to indicate there is no threshold of this type. |
| 29 | - name: HardShutdownLow |
| 30 | type: double |
| 31 | default: NaN |
| 32 | description: > |
| 33 | The lower bound of the shutdown threshold. A value of 'NaN' is used |
| 34 | to indicate there is no threshold of this type. |
| 35 | - name: HardShutdownAlarmHigh |
| 36 | type: boolean |
| 37 | description: > |
| 38 | True if the sensor value has exceeded the defined bound. |
| 39 | False if the sensor value has not exceeded the defined bound. |
| 40 | |
| 41 | HardShutdownAlarmHigh may be set to False to clear an alarm condition. |
| 42 | The behavior of setting HardShutdownAlarmHigh to True is undefined. |
| 43 | - name: HardShutdownAlarmLow |
| 44 | type: boolean |
| 45 | description: > |
| 46 | True if the sensor value has exceeded the defined bound. |
| 47 | False if the sensor value has not exceeded the defined bound. |
| 48 | |
| 49 | HardShutdownAlarmLow may be set to False to clear an alarm condition. |
| 50 | The behavior of setting HardShutdownAlarmLow to True is undefined. |
| Matt Spinler | 70ee1cf | 2021-01-21 15:25:59 -0600 | [diff] [blame] | 51 | |
| 52 | signals: |
| 53 | - name: HardShutdownHighAlarmAsserted |
| 54 | description: > |
| 55 | The high threshold alarm asserted. |
| 56 | properties: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 57 | - name: SensorValue |
| 58 | type: double |
| 59 | description: > |
| 60 | The sensor value that triggered the alarm change. |
| Matt Spinler | 70ee1cf | 2021-01-21 15:25:59 -0600 | [diff] [blame] | 61 | - name: HardShutdownHighAlarmDeasserted |
| 62 | description: > |
| 63 | The high threshold alarm deasserted. |
| 64 | properties: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 65 | - name: SensorValue |
| 66 | type: double |
| 67 | description: > |
| 68 | The sensor value that triggered the alarm change. |
| Matt Spinler | 70ee1cf | 2021-01-21 15:25:59 -0600 | [diff] [blame] | 69 | - name: HardShutdownLowAlarmAsserted |
| 70 | description: > |
| 71 | The low threshold alarm asserted. |
| 72 | properties: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 73 | - name: SensorValue |
| 74 | type: double |
| 75 | description: > |
| 76 | The sensor value that triggered the alarm change. |
| Matt Spinler | 70ee1cf | 2021-01-21 15:25:59 -0600 | [diff] [blame] | 77 | - name: HardShutdownLowAlarmDeasserted |
| 78 | description: > |
| 79 | The low threshold alarm deasserted. |
| 80 | properties: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 81 | - name: SensorValue |
| 82 | type: double |
| 83 | description: > |
| 84 | The sensor value that triggered the alarm change. |