Example Carbon Dioxide Sensor - NRCHKB/node-red-contrib-homekit-bridged GitHub Wiki

Properties

Available Properties

To have a Carbon Dioxide Sensor appear in the Home.app showing a peak level you can setup the flow as carbon dioxide is detected. The following characteristic properties are available:

Characteristic	Optional/Required	Characteristic Properties (to enable property)
CarbonDioxideDetected	Required	{"CarbonDioxideDetected": 0}
CarbonDioxideLevel	Optional	{"CarbonDioxideLevel": 579}
CarbonDioxidePeakLevel	Optional	{"CarbonDioxidePeakLevel": 1000}
StatusActive	Optional	{"StatusActive":true}

Details

Characteristic	Format	Accepted Values	Notes
CarbonDioxideDetected	uint8	0, 1	0: levels normal, 1: levels abnormal
CarbonDioxideLevel	float	0 - 100,000	Sets current carbon dioxide level in PPM
CarbonDioxidePeakLevel	float	0 - 100,000	This is the peak level detected. It could be used as a 24-hour maximum or an all time maximum depending on the Node-RED programming.
StatusActive	bool	true/false	{"StatusActive":true} / {"StatusActive":false}

Example

These examples are meant to be copied into your Node-RED system and adapted to your setup.

Please note: Different from other HomeKit services (e. g. temperature sensor) the Home.app is not showing the carbon dioxide level on the device icon. To view the current value you have to open the preferences of the device in the Home.app. This works as designed by Apple and can't be changed with characteristics properties.

Simple CO2 Sensor

This example is a simple CO2 sensor that is only ever "triggered" or "normal". The msg.payload going in is either {"CarbonDioxideDetected":1} or {"CarbonDioxideDetected":0} where 1 is "carbon dioxide detected" and 0 is "normal conditions".

[{"id":"abf13091.ebbd38","type":"homekit-service","z":"54339415.36f384","bridge":"b070e578.4eca1","name":"Simple CO2","serviceName":"CarbonDioxideSensor","topic":"","manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number","characteristicProperties":"{}","x":870,"y":380,"wires":["e1bd6875.39b18"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"e1bd6875.39b18")},{"id":"e1bd6875.39b18","type":"debug","z":"54339415.36f384","name":"CO2 Debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":1050,"y":380,"wires":[]},{"id":"46f9e422.63a86c","type":"inject","z":"54339415.36f384","name":"Detected","topic":"","payload":"{\"CarbonDioxideDetected\":1}","payloadType":"json","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":680,"y":360,"wires":["abf13091.ebbd38"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"abf13091.ebbd38")},{"id":"ea1120d0.634c88","type":"inject","z":"54339415.36f384","name":"Not Detected","topic":"","payload":"{\"CarbonDioxideDetected\":0}","payloadType":"json","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":670,"y":400,"wires":["abf13091.ebbd38"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"abf13091.ebbd38")},{"id":"b070e578.4eca1","type":"homekit-bridge","z":"","bridgeName":"Node-Red-Homekit-Bridge","pinCode":"270-21-969","port":"34567","allowInsecureRequest":false,"manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number"}]

Full Featured CO2 Sensor

This is a example of a CO2 Sensor that triggers an event message in the Home.app in case the CO2 level is above a threshold level of 1000. In this example the input nodes is a inject node just for a value of an assumed carbon dioxide level. In real life the author of that example gather the current value from a Netatmo weather stations by accessing the Netatmo Connect API. The debug node will return values set in the payload as it available in the Home.app on an Apple device.

Copyable Node-RED flow:

[{"id":"8770fe88.65de18","type":"switch","z":"755d7c8e.995f8c","name":"Check CO2 Peaklevel","property":"payload","propertyType":"msg","rules":[{"t":"gt","v":"1000","vt":"str"},{"t":"else"}],"checkall":"true","repair":false,"outputs":2,"x":480,"y":680,"wires":["3cf3572b.dd77f"],["aab3e31b.79b0e8"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"3cf3572b.dd77f"],["aab3e31b.79b0e8")},{"id":"3cf3572b.dd77f","type":"change","z":"755d7c8e.995f8c","name":"Set HkMsg CO2 PeakLevel Detected","rules":[{"t":"set","p":"payload.CarbonDioxidePeakLevel","pt":"msg","to":"payload","tot":"msg"},{"t":"move","p":"payload","pt":"msg","to":"payload.CarbonDioxideLevel","tot":"msg"},{"t":"set","p":"payload.CarbonDioxideDetected","pt":"msg","to":"1","tot":"num"},{"t":"set","p":"payload.StatusActive","pt":"msg","to":"true","tot":"bool"}],"action":"","property":"","from":"","to":"","reg":false,"x":790,"y":660,"wires":["b447171f.8d65d"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"b447171f.8d65d")},{"id":"aab3e31b.79b0e8","type":"change","z":"755d7c8e.995f8c","name":"Set HkMsg CO2 No PeakLevel Detected","rules":[{"t":"set","p":"payload.CarbonDioxidePeakLevel","pt":"msg","to":"payload","tot":"msg"},{"t":"move","p":"payload","pt":"msg","to":"payload.CarbonDioxideLevel","tot":"msg"},{"t":"set","p":"payload.CarbonDioxideDetected","pt":"msg","to":"0","tot":"num"},{"t":"set","p":"payload.StatusActive","pt":"msg","to":"true","tot":"bool"}],"action":"","property":"","from":"","to":"","reg":false,"x":780,"y":700,"wires":["b447171f.8d65d"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"b447171f.8d65d")},{"id":"ad845a09.a164e","type":"debug","z":"755d7c8e.995f8c","name":"CO2 Debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":1210,"y":680,"wires":[]},{"id":"aae48b15.370328","type":"inject","z":"755d7c8e.995f8c","name":"Inject 567 ppm","topic":"","payload":"567","payloadType":"num","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":260,"y":660,"wires":["8770fe88.65de18"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"8770fe88.65de18")},{"id":"ac3f99c0.5a69b","type":"inject","z":"755d7c8e.995f8c","name":"Inject 1357 ppm (above peak level)","topic":"","payload":"1357","payloadType":"num","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":200,"y":700,"wires":["8770fe88.65de18"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"8770fe88.65de18")},{"id":"b447171f.8d65d","type":"homekit-service","z":"755d7c8e.995f8c","bridge":"62369164.fea14","name":"CO2","serviceName":"CarbonDioxideSensor","topic":"","manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number","characteristicProperties":"{\n    \"StatusActive\" : true,\n    \"CarbonDioxideLevel\" : 0,\n    \"CarbonDioxidePeakLevel\" : 1000,\n    \"CarbonDioxideDetected\" : 0\n}","x":1050,"y":680,"wires":["ad845a09.a164e"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"ad845a09.a164e")},{"id":"e974015c.28036","type":"comment","z":"755d7c8e.995f8c","name":"Simulate CO2 Level","info":"","x":130,"y":600,"wires":[]},{"id":"2bf9335e.50b4a4","type":"comment","z":"755d7c8e.995f8c","name":"Set and Check Peak Level","info":"","x":490,"y":600,"wires":[]},{"id":"d9d67e9b.e3bdd8","type":"comment","z":"755d7c8e.995f8c","name":"Set Payload according to HAP specification","info":"","x":790,"y":600,"wires":[]},{"id":"62369164.fea14","type":"homekit-bridge","z":"","bridgeName":"Node-Red-Homekit-Bridge","pinCode":"270-21-969","port":"34567","allowInsecureRequest":false,"manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number"}]

This example triggers a message in iOS if the carbon dioxide level raises above 1000 ppm an set the status of the device in the Home.app to peak level detected. You can now use that to create an automation in the Home.app triggered by carbon dioxide peak level. If the level would fall below the selected peak level, the Peak level detection will be deactivated. In addition to that you can now ask Siri what the carbon dioxide level in the room you assign the sensor in the Home.app. But most important, if you are using Netatmo Weather Station as the source of your in and outdoor climatic measurement you can now bridge the gap of the missing HomeKit compatibility of Netatmo.

Monitoring peak level and event handling

This is another example how to deal with the event interaction on iOS. The following flow saves the recent peak level in a context variable of the node and always updates the CarbonDioxidePeakLevel if it is larger than the previous measurement cycle. If the level goes up a particular value (e. g. 1000ppm is set in the example) it changes the CarbonDioxideDetected property to 1 which causes an alarm in the iOS Home.app.

The alarm will be reseted after 30sec based on the individual reset. Also the recent peak level is set to null for some reasons.

Copyable Node-RED flow:

[{"id":"e974015c.28036","type":"comment","z":"755d7c8e.995f8c","name":"Simulate CO2 Level","info":"","x":130,"y":820,"wires":[]},{"id":"2bf9335e.50b4a4","type":"comment","z":"755d7c8e.995f8c","name":"Check peak level and reset alarm","info":"","x":830,"y":820,"wires":[]},{"id":"d9d67e9b.e3bdd8","type":"comment","z":"755d7c8e.995f8c","name":"Set Payload according to HAP specification","info":"","x":510,"y":820,"wires":[]},{"id":"83ebb81b.259b28","type":"comment","z":"755d7c8e.995f8c","name":"Event Notification for CO2 Peak Level","info":"","x":850,"y":880,"wires":[]},{"id":"2c7015be.019e32","type":"homekit-service","z":"755d7c8e.995f8c","bridge":"890aedc6.d0b418","name":"CO2 Sensor","serviceName":"CarbonDioxideSensor","topic":"","manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number","characteristicProperties":"{\n    \"CarbonDioxideLevel\" : 0,\n    \"CarbonDioxidePeakLevel\": 1000,\n    \"CarbonDioxideDetected\" : 0,\n    \"StatusActive\" : true\n}","x":770,"y":1040,"wires":[]]},{"id":"3022ebf7.8a551c","type":"function","z":"755d7c8e.995f8c","name":"Detect Highest Value","func":"var currentCo2PeakLevel = context.get('lastCo2PeakLevel') ](/NRCHKB/node-red-contrib-homekit-bridged/wiki/|-0;\n\nvar-newMsg-=-{};\nnewMsg.payload-=-{\n----\"CarbonDioxidePeakLevel\"-:-currentCo2PeakLevel,\n----\"CarbonDioxideDetected\"-:-0\n};\n\n//-Check-new-Peak-Level\nif-(msg.payload.CarbonDioxideLevel->-currentCo2PeakLevel)-{\n----context.set('lastCo2PeakLevel',-newMsg.payload.CarbonDioxideLevel);\n----newMsg.payload.CarbonDioxidePeakLevel-=-msg.payload.CarbonDioxideLevel;\n}\n\n//-Check-Peak-in-critical-level\nif-(msg.payload.CarbonDioxideLevel->=-1000)-{\n----newMsg.payload.CarbonDioxideDetected-=-1;\n}-\n\nreturn-newMsg;","outputs":1,"noerr":0,"x":800,"y":920,"wires":[["c5c3ed3e.6b786")},{"id":"ad3b0eb7.5f9ba","type":"change","z":"755d7c8e.995f8c","name":"Reset Payload for HkMsg CO2","rules":[{"t":"set","p":"payload","pt":"msg","to":"{\"CarbonDioxidePeakLevel\":null,\"CarbonDioxideDetected\":0}","tot":"json"}],"action":"","property":"","from":"","to":"","reg":false,"x":470,"y":1040,"wires":["2c7015be.019e32"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"2c7015be.019e32")},{"id":"103a2552.ac770b","type":"change","z":"755d7c8e.995f8c","name":"Set payload to HkMsg CO2","rules":[{"t":"move","p":"payload","pt":"msg","to":"payload.CarbonDioxideLevel","tot":"msg"},{"t":"set","p":"payload.StatusActive","pt":"msg","to":"true","tot":"bool"}],"action":"","property":"","from":"","to":"","reg":false,"x":460,"y":980,"wires":["2c7015be.019e32","3022ebf7.8a551c"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"2c7015be.019e32","3022ebf7.8a551c")},{"id":"c5c3ed3e.6b786","type":"trigger","z":"755d7c8e.995f8c","op1":"","op2":"{\"CarbonDioxideDetected\" : 0}","op1type":"pay","op2type":"json","duration":"30","extend":false,"units":"s","reset":"","bytopic":"all","name":"Reset Detection after 30 sec","x":820,"y":980,"wires":["2c7015be.019e32"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"2c7015be.019e32")},{"id":"d76e543e.1085e","type":"inject","z":"755d7c8e.995f8c","name":"Reset","topic":"","payload":"true","payloadType":"bool","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":110,"y":1040,"wires":["ad3b0eb7.5f9ba"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"ad3b0eb7.5f9ba")},{"id":"94a11c82.273ca8","type":"inject","z":"755d7c8e.995f8c","name":"0 ppm","topic":"","payload":"0","payloadType":"num","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":110,"y":900,"wires":["103a2552.ac770b"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"103a2552.ac770b")},{"id":"9e4aeb3f.0bc4e","type":"inject","z":"755d7c8e.995f8c","name":"678 ppm","topic":"","payload":"678","payloadType":"num","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":120,"y":940,"wires":["103a2552.ac770b"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"103a2552.ac770b")},{"id":"3ccbca9e.00895e","type":"inject","z":"755d7c8e.995f8c","name":"1357 ppm","topic":"","payload":"1357","payloadType":"num","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":120,"y":980,"wires":["103a2552.ac770b"](/NRCHKB/node-red-contrib-homekit-bridged/wiki/"103a2552.ac770b")},{"id":"890aedc6.d0b418","type":"homekit-bridge","z":"","bridgeName":"Node-Red-HAP-Bridge-02","pinCode":"222-22-222","port":"","allowInsecureRequest":false,"manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number"}]

Some credits for this example goes to crxporter for the inspiration.