Nonstick Pancake Maker

    homebridge-philipsair-platform

    1.0.2 • Public • Published

    homebridge-philipsair-platform

    npm npm GitHub last commit Discord Donate

    Creating and maintaining Homebridge plugins consume a lot of time and effort, if you would like to share your appreciation, feel free to "Star" or donate.

    Click here to review more of my plugins.

    Info

    This is a plugin for Philips Air Purifier/Humidifier.

    This plugin supports following functions:

    • Air Purifier
    • Humidifier
    • Device Lights
    • Temperature Sensor
    • Humidity Sensor

    Installation

    After Homebridge has been installed:

    sudo npm install -g --unsafe-perm homebridge-philipsair-platform@latest
    

    The plugin uses a library based on python3. To use the plugin, Python/Pip must be installed!

    sudo apt install python3-pip git
    

    You also need the aioairctrl module from Peter-J

    sudo pip3 install -U git+https://github.com/Peter-J/aioairctrl
    

    Example Config

    {
       ...
        "platforms": [
            {
                "platform": "PhilipsAirPlatform",
                "name": "PhilipsAirPlatform",
                "debug": false,
                "warn": true,
                "error": true,
                "extendedError": true,
                "devices": [
                    {
                        "active": true,
                        "name": "Livingroom Philips",
                        "manufacturer": "Philips",
                        "model": "AC3829",
                        "serialNumber": "000000",
                        "host": "192.168.178.111",
                        "port": 3333,
                        "light": true,
                        "temperature": true,
                        "humidity": true,
                        "humidifier": true,
                        "allergicFunc": true,
                        "sleepSpeed": false
                    }
                ]
            }
        ]
    }
    
    
    Fields Description Default Required
    platform Must always be PhilipsAirPlatform. "PhilipsAirPlatform" Yes
    name For logging purposes. "PhilipsAirPlatform" No
    debug Enables additional output (debug) in the log. false No
    warn Enables additional output (warn) in the log. true No
    error Enables additional output (error) in the log. true No
    extendedError Enables additional output (detailed debug) in the log. true No
    devices Array of Philips air purifiers. Yes
    - name Unique name of your device. Yes
    - host Host/IP address of your device. Yes
    - port Port of your device. 5683 No
    - manufacturer Set the manufacturer name for display in the Home app. "Philips" No
    - model Set the model for display in the Home app. "Air Purifier" No
    - serialNumber Set the serial number for display in the Home app. "000000" No
    - humidifier Expose a separate humidifier accessory to HomeKit. false No
    - light Expose device lights as lightbulbs to HomeKit. false No
    - temperature Expose device temperature as temperature sensor to HomeKit. false No
    - humidity Expose device humidity as humidity sensor to HomeKit. false No
    - allergicFunc Does this device support 'allergic' function? false No
    - sleepSpeed Does this device support 'sleep' speed? false No

    For a full config.json, please look at Example Config for more details.

    Tested devices

    The following devices have been tested with this plugin and confirm that they work without problems

    • AC3829

    Supported clients

    This plugin has been verified to work with the following apps/systems:

    • iOS > 13
    • Apple Home
    • All 3rd party apps like Elgato Eve etc
    • Homebridge >= v1.3.0
    • Node >= 14

    TODO

    • [ ] FakeGato Support

    Contributing

    This project is heavily inspired by https://github.com/NikDevx/homebridge-philips-air - Since the plugin didn't work for me, I wrote a new one from scratch. The homebridge-philips-air was a very great help for the implementation!

    You can contribute to this homebridge plugin in following ways:

    • Report issues and help verify fixes as they are checked in.
    • Review the source code changes.
    • Contribute bug fixes.
    • Contribute changes to extend the capabilities
    • Pull requests are accepted.

    See CONTRIBUTING

    Troubleshooting

    If you have any issues with the plugin then you can run this plugin in debug mode, which will provide some additional information. This might be useful for debugging issues. Just open your config ui and set debug to true!

    Disclaimer

    All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

    License

    MIT License

    Copyright (c) 2020-2021 SeydX

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i homebridge-philipsair-platform

    DownloadsWeekly Downloads

    22

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    52.6 kB

    Total Files

    17

    Last publish

    Collaborators

    • seydx