feat(cloud): add support for Japanese Toshiba IOLife devices

[audunmg]

Not intended to be merged, but opening a PR to show this is being worked on (slowly), and maybe attract comments and help.

For now, the cloud functions are working (except the one to download lua files, and i suspect that will never work), but that's the only working thing.

The local protocol to actually communicate with the devices is not working at all (yet).

[coderabbitai]

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (6)

• misc
• bug
• configuration
• dependencies
• enhancement
• test

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[chemelli74]

Hi, thank to so much for the contribution!

Please always use the correct env (devcontainer or use at least setup script) so you'll have the complete env for development and get the checks running locally.

[audunmg]

After a lot of effort, I've realized that the lua files aren't fetched from the API at all, they are only distributed with the app, so the downloadLua will probably never work, at least not for my appliances.

It always returns 404 (when authenticated), and not 401, so that's maybe telling, and maybe it will work for someone else's Japanese Toshiba appliance.

I will extract the lua files from the app and start porting the protocol.

The list_appliances function work well, and I don't think there are more cloud functions needed to get local support working.

Do you prefer to keep the vestigal download_lua function in case it's activated later, or should I just remove it from this PR?

[audunmg]

Since you renamed this to feat(cloud), then maybe I should open a separate PR for parsing the protocol?

I'm looking forward to finally getting this working :)

[wuwentao]

@audunmg if you want to add a new cloud support, you should find out the cloud URL and params for this cloud URL, also include the cloud server URL for this cloud, then you can got a expected http 200 response from the server.
and lua file will be used for a device to init download from cloud server, then run this lua app in your app as a application.
so lua file always exist in server side and server can control the version with your device SN or SN8.
for example, the cloud server and download lua is different URL for smarthome and meiju app, so you can't always using the same URL with different cloud service.

I'm not familar with all the detail, but just try to read all the source code and exist feature, got this per my understand.
if there is something error, you can continue works with it.
and I'm currently on vacation, so my time is not very convenient these weeks.

[wuwentao]

@audunmg these id/key maybe works for you.

please check with MeijuCloud and SmartHomeCloud args, use these value for your TsmartLife cloud test.

midea-local/midealocal/cloud.py

Line 31 in 498bbe2

SUPPORTED_CLOUDS = {

"setting_aboutUs_appName" : "TSmartLife",

APP_ID = "1000";
APP_KEY = "2f39d871a38a4841aab3be3837e39cf4";

CLIENT_TYPE = "1";

"https://mp-prod.appsmb.com/";
"https://mp-prod.appsmb.com/mas/v5/app/";
"https://mp-prod.appsmb.com/mas/v5/app/proxy?alias="

if https://mp-prod.appsmb.com/ can't works, maybe you can try with
https://mp-jp-prod.appsmb.com/

"https://mp-jp-prod.appsmb.com/";
"https://mp-jp-prod.appsmb.com/mas/v5/app/";
"https://mp-jp-prod.appsmb.com/mas/v5/app/proxy?alias="

thanks

[audunmg]

Thanks! I will try at the first opportunity!

[audunmg]

I was able to test, but my appliances doesn't seem to work with TSmartLife, but they work with the IOLife cloud.

I'm speculating that the TSmartgLife is for Toshiba appliances outside of Japan?

In any case, the IOlife cloud keys work and is able to get my list of appliances (with keys!), and I've verified that my IOLife app doesn't download lua files from the API.

I've been able to extract them some other way, so I'll make a separate PR with those files.

[wuwentao]

@audunmg thanks for the info share.
I'm not sure with TsmartLife app.
and you can also try with SmartHome app, you don't need to add your device to Smarthome, just using Builtin account or you can register a new user(download lua).
anyway, IOLife can works for you device, token is the most important info than lua.

[audunmg]

Correction: I thought i got keys, but i see now it's using the default keys instead and is not able to communicate with my applicance.
So far, the only successful cloud request i can do is list appliances. At least it does that successfully and shows custom names of my appliances.

[wuwentao]

you can refer to config_flow, I have add a brief step description.
and all the source code should have comments, you can refer to it.
the first stage will try with user input cloud, if it can't work, will rollback to default built in account and cloud.
if both can't works, will return error.
https://github.com/wuwentao/midea_ac_lan/blob/master/custom_components/midea_ac_lan/config_flow.py

[audunmg]

A lot has happened since i started this PR, and i forgot where i got stuck.

I did a rebase, and tested with python -m midealocal.cli discover -d

It's able to retrieve keys, and connect, but the protocol is wrong, and that's why I needed the lua files.
This is the error i get(with some messages leading up to it):

2024-12-23 06:10:26.466 DEBUG (MainThread) [midealocal.device] [24189258014223] Connecting to XXX:6444
2024-12-23 06:10:26.568 DEBUG (MainThread) [midealocal.device] [24189258014223] Connected
2024-12-23 06:10:26.569 DEBUG (MainThread) [midealocal.device] [24189258014223] Authentication handshaking
2024-12-23 06:10:26.666 DEBUG (MainThread) [midealocal.device] [24189258014223] Received auth response with 72 bytes: XXX
2024-12-23 06:10:26.666 DEBUG (MainThread) [midealocal.device] [24189258014223] Authentication success
2024-12-23 06:10:26.666 DEBUG (MainThread) [cli] Trying to connect with key: {'token': 'XXX', 'key': 'XXX'}
2024-12-23 06:10:26.666 DEBUG (MainThread) [midealocal.device] [24189258014223] Authentication handshaking
2024-12-23 06:10:26.729 DEBUG (MainThread) [midealocal.device] [24189258014223] Received auth response with 72 bytes: 8370004020XXX
2024-12-23 06:10:26.729 DEBUG (MainThread) [midealocal.device] [24189258014223] Authentication success
2024-12-23 06:10:26.729 DEBUG (MainThread) [cli] Trying to retrieve device attributes.
2024-12-23 06:10:26.730 DEBUG (MainThread) [midealocal.device] [24189258014223] refresh_status with cmds: [<midealocal.message.MessageQueryAppliance object at 0x71e40e730ad0>, <midealocal.devices.ac.message.MessageQuery object at 0x71e40f163ce0>, <midealocal.devices.ac.message.MessageNewProtocolQuery object at 0x71e40e5df5f0>, <midealocal.devices.ac.message.MessagePowerQuery object at 0x71e40e5df260>], check_protocol True
...
2024-12-23 06:10:34.736 ERROR (MainThread) [cli] Unable to retrieve device attributes.
Traceback (most recent call last):
  File "/srv/midealocal/cli.py", line 126, in discover
    dev.refresh_status(True)
  File "/srv/midealocal/device.py", line 384, in refresh_status
    raise NoSupportedProtocol
midealocal.device.NoSupportedProtocol

[wuwentao]

@audunmg if you can get token and pass auth, it should finished about 70%-80%.

you need to add a new query msg to trigger your device response to this query and parse the response with a body class, and update the result to HA.
it should works for sensor data.

1. you can use smarthome to download lua file
2. or dig out the lua file download URL in your IOlife/ToshibaLife APP.
3. you can also refer to current MeijuCloud and SmartHomeCloud, they are using different URL, you can have a try with these URL path.