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