Homebridge Panasonic AC Platform

homebridge-panasonic-ac-platform is a dynamic platform plugin for Homebridge which provides HomeKit support for Panasonic Comfort Cloud devices (such as single and multi-split air conditioning systems).

How it works

The plugin communicates with your devices through the Comfort Cloud service. This means you must have a Comfort Cloud account (Panasonic ID) and your units must be registered and set up there before you can use this plugin.

All devices that are set up on your Comfort Cloud account will automaticaly appear in Homebridge and via HomeKit in your Home app (or other HomeKit app). If you remove a device from your Comfort Cloud account, it will also disappear from your Homebridge and HomeKit app after you restart Homebridge (unless you have the option to 'keep accessories of uninstalled plugins' selected in Homebridge settings). You can also exclude one or more devices. For each device you can apply individual settings.

Comfort Cloud account (Panasonic ID)

• Register and manage your Panasonic ID (used to manage Comfort Cloud) via app (iOS / Android) or browser Panasonic ID.
• From January 2024, Panasonic requires 2FA (Two Factor Authentication), you can choose: the code or SMS - the recommended choice is the code.
• Instructions on how to create a dual-account setup.

Install plugin

This plugin can be easily installed and configured through Homebridge UI or via NPM "globally" by typing:

npm install -g homebridge-panasonic-ac-platform

Configure plugin

Configure the plugin through the settings UI or directly in the JSON editor.

Basic settings (required):

{
  "platforms": [
    {
        "platform": "Panasonic AC Platform",
        "name": "Homebridge Panasonic AC Platform",
        "email": "[email protected]",
        "password": "********"
    }
  ]
}

• platform (string): Tells Homebridge which platform this config belongs to. Leave as is.
• name (string): Name of the plugin displayed in Homebridge log and as plugin bridge name.
• email (string): The username of your Comfort Cloud (Panasonic ID) account.
• password (string): The password of your Comfort Cloud (Panasonic ID) account.

Example:

{
  "platforms": [
    {
        "platform": "Panasonic AC Platform",
        "name": "Homebridge Panasonic AC Platform",
        "email": "[email protected]",
        "password": "********",
        "key2fa": "GVZCKT2LLBLV2QBXMFAWFXKFKU5EWL2H",
        "excludeDevices": "",
        "appVersionOverride": "1.21.0",
        "suppressOutgoingUpdates": false, 
        "logsLevel": 1,
        "devices": [
                {
                    "name": "CS-Z50VKEW+4942673181",
                    "excludeDevice": true,
                    "autoMode": "auto",
                    "oscilateSwitch": "swing",
                    "forceSwing": "false",
                    "forceNanoe": "false",
                    "forceInsideCleaning": "false",
                    "forceEcoNavi": "false",
                    "swingModeDirections": "LEFT-RIGHT-UP-DOWN",
                    "swingModeDefaultPositionUpDown": "CENTER",
                    "swingModeDefaultPositionLeftRight": "CENTER",
                    "exposeOutdoorUnit": false
                },
                 {
                    "name": "Bedroom AC",
                    "excludeDevice": false,
                    "autoMode": "auto",
                    "oscilateSwitch": "nanoe",
                    "forceSwing": "false",
                    "forceNanoe": "true",
                    "forceInsideCleaning": "false",
                    "forceEcoNavi": "false",
                    "swingModeDirections": "LEFT-RIGHT-UP-DOWN",
                    "swingModeDefaultPositionUpDown": "CENTER",
                    "swingModeDefaultPositionLeftRight": "CENTER",
                    "exposeOutdoorUnit": true,
                    "minHeatingTemperature": 8
                },
            ]
    }
  ]
}

Advanced fields

• key2fa (string): 2FA key received from Panasonic (32 characters). Example: GVZCKT2LLBLV2QBXMFAWFXKFKU5EWL2H. Note: This field is currently not required to make this plugin work, but Panasonic already requires 2FA (code or SMS, recommended code) to log in to Comfort Cloud, so it may be required soon.

• excludeDevices (string): By default this plugin will add all devices from Comfort Cloud. To exclude one or more, put comma separated names or serial numbers of devices, E.G.: 'CS-Z50VKEW+4962605183,Bedroom AC,CS-Z50VKEW+4962605184,My AC unit'.

• appVersionOverride (string): Leave this field empty to automatically fetch the latest version from the App Store and if that fails, it will use the last known working value which is hard-coded. Filling in this field will make the entered version used (automatic overwriting of versions from the App Store will not work).

• suppressOutgoingUpdates (boolean): When enabled, changes in the Home app will not be sent to Comfort Cloud. Useful for testing your installation without constantly switching the state of your AC.

• logsLevel (integer): Logs level. 0 - only errors and important info, 1 - standard, 2 - all (including debug). Note: to see debug messages in logs it is also required to enable Debug in Homebridge Settings.

Inividual for each device

• name (string): Device name (as it is in Comfort Cloud account) or serial (E.G.: CS-Z50VKEW+2462503161). Devices names and serial numbers are displayed in Homebridge log after restart, names can be also found in Panasonic Comfort Cloud app, serial numbers can be also found on the stickers on the devices.

• excludeDevice (boolean): Exclude device from Homebridge and HomeKit (it will stay in Comfort Cloud).

• autoMode (string): HomeKit has only 3 modes: Auto, Cool, Heat but Panasonic additionally has Fan and Dry. Choose what mode to be turned on after selecting the Auto mode in HomeKit: Fan mode, Dry mode or Auto mode (by default).

• oscilateSwitch (string): HomeKit has only one 'Oscillate' switch, but most Panasonic ACs have more options: Nanoe, Eco Navi, Inside Cleaning and Swing mode have two swing directions. Decide what the switch should control: Swing Mode, Nanoe, Eco Navi or Inside Cleaning.

• forceSwing (string): Swing value with each state change made with Homekit (e.g. activation): do nothing, set on, set off.

• forceNanoe (string): Nanoe value with each state change made with Homekit (e.g. activation): do nothing, set on, set off.

• forceInsideCleaning (string): InsideCleaning value with each state change made with Homekit (e.g. activation): do nothing, set on, set off.

• forceEcoNavi (string): Eco Navi value with each state change made with Homekit (e.g. activation): do nothing, set on, set off.

• swingModeDirections (string): Desired swing direction(s) activated when swing is switched on.

• swingModeDefaultPositionUpDown (string): Desired position of the Up-Down flaps when swing is switched off or the swing directions setting is Left-Right only.

• swingModeDefaultPositionLeftRight (string): Desired position of the Left-Right flaps when swing is switched off or the swing directions setting is Up-Down only.

• exposeOutdoorUnit (boolean): When enabled it will create a dummy temperature sensor which will display the temperature from outdoor unit. This can be used for monitoring or automation purposes. Note: It may be required for the device to be turned on to retrieve the current temperature from the outdoor unit.

• minHeatingTemperature (integer): The default heating temperature range is 16-30°C. Some Panasonic ACs have an additional heating mode for the range of 8-15°C. You can use this setting to adjust the minimum value. Leave it empty to use the default value.

Device control

HomeKit has a limited number of switches, which is much less than the number of available options in Panasonic Comfort Cloud. Therefore, in the settings you can choose what controls what. You can apply individual settings for each device.

HomeKit offers no extra switches for the Quiet and Powerful Modes. All settings related to a unit's fan speed are controlled through the fan speed slider. The following mapping applies:

| Home app slider position | Comfort Cloud setting | | ------------------------: | --------------------- | | (leftmost) 0 | Device off | | 1 | Quiet mode | | 2 | Fan speed: 1 | | 3 | Fan speed: 2 | | 4 | Fan speed: 3 | | 5 | Fan speed: 4 | | 6 | Fan speed: 5 | | 7 | Powerful mode | | (rightmost) 8 | Auto |

The data is refreshed automatically: every 10 minutes when the device is turned on and every 60 minutes when it is turned off. Data is also refreshed every time the state of the device is changed using HomeKit / Apple Home.

Troubleshooting

• Make sure that you can successfully log in and control each device via Panasonic Comfort Cloud application.
• Accept all terms, conditions, etc in Panasonic Comfort Cloud app.
• Update plugin, Homebridge and all its components and Apple hubs to the newest versions.
• Field Comfort Cloud app version (in plugin settings) should be empty or have newest Comfort Cloud app version (same as in Apple App Store).
• Disconnect each Comfort Cloud device (like AC) from the power and turn it on again (or restart WiFi in them).
• Restart Internet routers.
• Restart Homebridge or plugin bridge.
• Remove one or move device from Homebridge cache (Homebridge settings > remove one device from cache).
• Set Logs Level to all (in plugin config) and enable debug mode (in Homebridge settings). This will include more detailed information in the log.

• It's recommended you run this plugin as a child bridge.

• Built-in temperature sensors (in the internal and external unit) give only approximate values (As the manufacturer himself indicates).
• Values from outdoor sensors are shown and updated only when the device is turned on.
• Comfort Cloud updates data only from time to time, the same plugin, which is why the temperature in the Panasonic Comfort Cloud application may be different than in HomeKit / Apple Home. You can force refresh in Panasonic app by pulling down the screen.
• For these reasons, it is not recommended to use built-in sensors for automation. Instead, it is advisable to use an external sensor.
• So what are these built-in sensors for? Internal sensor is for two simple automations that every AC have built-in: for cooling mode turn off cooling when the room temperature (internal sensor) is equal to or lower than the set, and for heating mode when it is equal or higher. Outdoor sensor is for detecting when AC should run defrost.

If everything works properly and you can control devices using the Apple Home application, you can also control it using Siri. Commands fully depend on Apple.

Examples of commands:

• Hey Siri, turn on [device name]
• Hey Siri, [device name] , turn off
• Hey Siri, [device name] , set [auto, heat, cool] mode
• Hey Siri, [device name] , set rotation speed , [value from 1 to 8]

Contributing and support

• Test/use the plugin and report issues and share feedback.
• Contribute with your own bug fixes, code clean-ups, or additional features - Pull Request.
• See more: contributing-collaborators.md.

Acknowledgements

• Thanks to embee8 for creating this plugin.
• Thanks to codyc1515 for creating and maintaining homebridge-panasonic-air-conditioner, which served as motivation for this platform plugin and proved particularly helpful in determining API request/response payloads.
• Thanks to the team behind Homebridge. Your efforts do not go unnoticed.

Disclaimer

• This is not the official Panasonic plugin. It uses the official Panasonic API used to support official applications for iOS and Android. Panasonic has not provided an official API to support external plugins, so this method may stop working at any time.
• Homebridge connect via Internet with Comfort Cloud (Panasonic platform), this solution does not work locally.
• Despite the efforts made, the operation of the plugin is without any guarantees and at your own risk.
• 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.

• Local access, but this requires reworking of the equipment, which will lose the warranty, so rather not recommended.

• Control by IR (imitates an IR remote control), but it only allows you to send commands (not possible to read the state). Examples:

  • Aqara Hub M2 or M3. This Hub will directly exposes IR to Homekit. You need to create scene in Aqara app for every IR command, for IR commands scenes are the only way to sync to HomeKit.

  • Broadlink RM4 Mini or Pro. They work as WiFi devices. You need to install Homebridge plugin (homebridge-broadlink-rm) to work with this. For every command there will be separate accessory in HomeKit.

  • Any Zigbee IR blaster. You can easily add Zigbee support to Homebridge. Just connect the Conbee stick, enable the support in hb-config (Extra packages / deCONZ), install the appropriate plugin (E.G.: homebridge-deconz) and add the selected IR blaster.