| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide performance loss class sensor thresholds. Objects |
| Patrick Williams | 86f8c53 | 2021-10-01 06:34:04 -0500 | [diff] [blame] | 3 | implementing Sensor.Threshold.PerformanceLoss must be instantiated in the |
| 4 | correct hierarchy within the sensors namespace. The following sensor |
| 5 | hierarchies are recognized: |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 6 | airflow |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 7 | altitude |
| 8 | current |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 9 | energy |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 10 | fan_tach |
| Patrick Williams | 1bcf7fa | 2021-12-22 09:14:37 -0600 | [diff] [blame] | 11 | humidity |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 12 | power |
| Patrick Williams | 86f8c53 | 2021-10-01 06:34:04 -0500 | [diff] [blame] | 13 | pressure |
| Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 14 | temperature |
| 15 | utilization |
| 16 | voltage |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 17 | |
| Patrick Williams | 86f8c53 | 2021-10-01 06:34:04 -0500 | [diff] [blame] | 18 | Additionally, any object implementing Sensor.Threshold.PerformanceLoss must |
| 19 | also implement Sensor.Value. |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 20 | |
| 21 | properties: |
| 22 | - name: PerformanceLossHigh |
| 23 | type: double |
| 24 | default: NaN |
| 25 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 26 | The upper bound of the warning threshold. A value of 'NaN' is used to |
| 27 | indicate there is no threshold of this type. |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 28 | - name: PerformanceLossLow |
| 29 | type: double |
| 30 | default: NaN |
| 31 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 32 | The lower bound of the warning threshold. A value of 'NaN' is used to |
| 33 | indicate there is no threshold of this type. |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 34 | - name: PerformanceLossAlarmHigh |
| 35 | type: boolean |
| 36 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 37 | True if the sensor value has exceeded the defined bound. False if the |
| 38 | sensor value has not exceeded the defined bound. |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 39 | |
| Patrick Williams | 86f8c53 | 2021-10-01 06:34:04 -0500 | [diff] [blame] | 40 | PerformanceLossAlarmHigh may be set to False to clear an alarm |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 41 | condition. The behavior of setting PerformanceLossAlarmHigh to True is |
| 42 | undefined. |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 43 | - name: PerformanceLossAlarmLow |
| 44 | type: boolean |
| 45 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 46 | True if the sensor value has exceeded the defined bound. False if the |
| 47 | sensor value has not exceeded the defined bound. |
| Matt Spinler | 1b4a98a | 2021-01-22 16:28:55 -0600 | [diff] [blame] | 48 | |
| Patrick Williams | 86f8c53 | 2021-10-01 06:34:04 -0500 | [diff] [blame] | 49 | PerformanceLossAlarmLow may be set to False to clear an alarm |
| 50 | condition. The behavior of setting PerformanceLossAlarmLow to True is |
| 51 | undefined. |
| Matt Spinler | 70ee1cf | 2021-01-21 15:25:59 -0600 | [diff] [blame] | 52 | signals: |
| 53 | - name: PerformanceLossHighAlarmAsserted |
| 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: PerformanceLossHighAlarmDeasserted |
| 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: PerformanceLossLowAlarmAsserted |
| 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: PerformanceLossLowAlarmDeasserted |
| 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. |