Toshiba Home AC Control smart home integration, free and open source
Your Toshiba Home AC Control air conditioners: mode, setpoint, fan, swing, ECO, Hi-POWER…
Published by LM1LC3N7
- Devices
- Version 0.1.1
- Requires Gladys >=5.1.0
- ★ 0
Toshiba air conditioners and air-to-air heat pumps with Wi-Fi (the RB-N105S-G / RB-N106S-G adapter, or built-in Wi-Fi) are controlled with the Toshiba Home AC Control app, through the Toshiba cloud. This integration signs in to that cloud with the account of your app, like the app does, and brings your units into Gladys: turn them on and off, change the mode, the setpoint, the fan and the swing, use the ECO, Hi-POWER, silent and 8 °C heating modes, and follow the indoor and outdoor temperatures, live.
Unofficial: not affiliated with Toshiba nor with Toshiba Carrier.
Development version (0.1). Ported from the
toshiba-acPython library that the Home Assistant integration uses, and checked against what that library computes; not yet tested with a real Toshiba account. Your feedback is welcome on the GitHub repository.
Which units
- Yes: the units you control with the Toshiba Home AC Control app (for example Seiya, Shorai, Daiseikai and the consoles sold in Europe).
- No: the North American window and portable units of the Toshiba AC NA app. They are made by Midea and use the Midea cloud: use the Midea integration of the Gladys store for them.
What you get
One Gladys air conditioner per unit of the account, with the features the unit supports (Toshiba says which in the device list):
| Feature | In Gladys |
|---|---|
| On/off | air conditioner on/off |
| Mode | auto, cool, heat, dry, fan (only the modes of the unit) |
| Setpoint | 17 to 30 °C, whole degrees; 5 to 13 °C in 8 °C heating |
| Fan speed | auto, quiet, low, medium low, medium, medium high, high |
| Vertical swing | off, swing, and the 5 fixed louver positions when the unit has them |
| Horizontal swing | off, swing (units with horizontal swing) |
| Power selection | 50 %, 75 %, 100 % |
| Special mode | none, Hi-POWER, ECO, silent 1/2 (outdoor unit), 8 °C heating, sleep, floor, comfort — one at a time, as the unit supports |
| Fireplace mode | off, fireplace 1, fireplace 2 (units that have it, heat mode) |
| Air purifier | on/off (units with Air Pure Ion) |
| Indoor, outdoor temperature | temperature sensors (°C) |
| Energy this year | kWh since January 1st (units that report it) |
The special modes follow Toshiba's rules: ECO, Hi-POWER and silent work in auto, cool and heat; 8 °C heating, floor and sleep in heat only. Switching to dry or fan mode turns the special mode off, like the app does.
Installation
- Check that your units work in the Toshiba Home AC Control app.
- In the configuration of the integration, type the user name and the password of the app. The user name is often not your e-mail address: many accounts have a short user name, shown in the account screen of the app.
- Click Test the connection: the units of the account are listed.
- Open the Discovery tab and add your units.
Type the password carefully: after two refused logins in a row, Toshiba blocks the account for a few hours, and while it is blocked even the right password is refused. The integration never retries a refused login on its own: fix the configuration and save it.
Options
| Option | Default | Purpose |
|---|---|---|
| Language of the feature names | French | names of the features and of their options |
How it works
- Gladys talks to the Toshiba cloud over the Internet, never to the unit directly: the unit must be online in the app.
- Live link: Gladys registers as a phone of your account and connects to the Toshiba IoT Hub (Microsoft Azure). The units send their changes and a regular heartbeat with their temperatures through it, and the commands go through it: while it is down, the units can be read but not controlled.
- The states are also read over the Toshiba API every 30 minutes (every 5 minutes while the live link is down), and right after it comes back.
- The sign-in is kept in the
/datafolder of the integration (Toshiba gives it for about three years), so a restart of Gladys does not sign in again: Toshiba limits the number of sign-ins. The password is never written there. - The transport badge of each unit shows cloud, with an orange dot while the live link is down, or unreachable when the Toshiba cloud does not answer.
Troubleshooting
- "refused the user name or the password": try the user name of the account screen of the app instead of the e-mail. Very long passwords with many symbols are known to fail: simplify it in the app if needed.
- "Toshiba is slowing this connection down": the Toshiba firewall throttles; it says nothing about your password. Wait, the integration tries again by itself (after the delay Toshiba asks, up to one hour).
- "refused the live link even with a new token": another client may use
the same identity. The integration registers its own identity: if you run
two Gladys on the same account, or copied the
/datafolder of one to the other, give each its own/data. - A command fails with "live link … down": wait for the reconnection (the status says when) and try again.
- The setpoint is refused: 17 to 30 °C, or 5 to 13 °C in 8 °C heating.
Credits
The protocol (states, commands, supported features) is ported from the toshiba-ac Python library by Kamil Sroka (Apache License 2.0), used by the Home Assistant integration home-assistant-toshiba_ac. The behaviour of the Toshiba firewall comes from the notes of that integration and of the homebridge-toshiba-home-ac plugin by Onur Yuksel (MIT).
Configuration settings
These are the settings Toshiba Home AC Control asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Your Toshiba air conditioners in Gladys | section | No | The Toshiba air conditioners and air-to-air heat pumps of your Toshiba Home AC Control app (RB-N105S-G / RB-N106S-G Wi-Fi adapter or built-in Wi-Fi) are offered in the Discovery tab: on/off, mode, setpoint, fan speed, swing and louver positions, power selection, Hi-POWER, ECO, silent and 8 °C heating modes, indoor and outdoor temperatures, and the energy when the unit reports it. The states arrive live from the Toshiba cloud, and the commands go through it. North American units of the Toshiba AC NA app are Midea units: use the Midea integration for them. Unofficial, not affiliated with Toshiba. |
| Toshiba Home AC Control user name | string | Yes | The user name you sign in to the app with. Many accounts have a short user name besides the e-mail address: if the e-mail is refused, use the user name shown in the account screen of the app. |
| Password | secret | Yes | Check it twice: after two refused logins in a row, Toshiba blocks the account for a few hours. A refused login is never retried on its own. |
| Language of the feature names | select | No | The names of the features and of the options (modes, fan speeds, special modes) of the discovered devices. |
How to install Toshiba Home AC Control in Gladys
- In Gladys, open Integrations: Toshiba Home AC Control appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/lm1lc3n7/gladys-toshiba-ac:0.1.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/LM1LC3N7/gladys-toshiba-ac.
Toshiba Home AC Control requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
Toshiba Home AC Control is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by LM1LC3N7, not by the Gladys core team.
- Browse all integrations, native and community
- Build and publish your own external integration
- Source code on GitHub — source of this documentation