ioBroker.woso_mitsu_aircon_rac

Tests:

woso_mitsu_aircon_rac adapter for ioBroker

Mitsubishi Aircon Adapter for RAC-WiFi-Modules.

This Adapter will give you the opportunity to connect to a localy (WiFi) installed Aircon of Mitsubishi Heavy with an RAC-WiFi-Module.

Right now you can get the Information from the Aircon, the function to send Data is already implemented, but there seems to be an error, that I can't find, so the function will be executed, but the data is not set properyly.

Developer manual

This code is based on the original JAVA-implementation of the Android App and the already converted Python-Scripts here: https://github.com/jeatheak/Mitsubishi-WF-RAC-Integration https://github.com/mcheijink/WF-RAC

Thank you very much for your work - It really helped me a lot.

The current code needs a little clean up, but for the first try it should work as a base to get the Informatione and maybe someone finds the error in sending the data? Feel free to fix or add some functions.

There are some more things to do - the integration is based on a fixed key for the device and operator. Additional functions are already set up, but not integrated right now (de-register the app from the aircon on unload the module ...)

DISCLAIMER

Please make sure that you consider copyrights and trademarks when you use names or logos of a company and add a disclaimer to your README. You can check other adapters for examples or ask in the developer community. Using a name or logo of a company without permission may cause legal problems for you.

Getting started

You are almost done, only a few steps left:

1. Clone the repository from GitHub to a directory on your PC:

   git clone https://github.com/wolkeSoftware/ioBroker.woso_mitsu_aircon_rac

2. Head over to main.js and start programming!

Best Practices

We've collected some best practices regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should check them out. If you're already experienced, you should also take a look at them - you might learn something new :)

Scripts in package.json

Several npm scripts are predefined for your convenience. You can run them using npm run <scriptname> | Script name | Description | |-------------|-------------| | test:js | Executes the tests you defined in *.test.js files. | | test:package | Ensures your package.json and io-package.json are valid. | | test:integration | Tests the adapter startup with an actual instance of ioBroker. | | test | Performs a minimal test run on package files and your tests. | | check | Performs a type-check on your code (without compiling anything). | | lint | Runs ESLint to check your code for formatting errors and potential bugs. | | translate | Translates texts in your adapter to all required languages, see @iobroker/adapter-dev for more details. | | release | Creates a new release, see @alcalzone/release-script for more details. |

Writing tests

When done right, testing code is invaluable, because it gives you the confidence to change your code while knowing exactly if and when something breaks. A good read on the topic of test-driven development is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. Although writing tests before the code might seem strange at first, but it has very clear upsides.

The template provides you with basic tests for the adapter startup and package files. It is recommended that you add your own tests into the mix.

Publishing the adapter

Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form v<major>.<minor>.<patch>. We strongly recommend that you do. The necessary steps are described in .github/workflows/test-and-release.yml.

Since you installed the release script, you can create a new release simply by calling:

npm run release

Additional command line options for the release script are explained in the release-script documentation.

To get your adapter released in ioBroker, please refer to the documentation of ioBroker.repositories.

Test the adapter manually with dev-server

Please use dev-server to test and debug your adapter.

You may install and start dev-server by calling from your dev directory:

npm install --global @iobroker/dev-server
dev-server setup
dev-server watch

Please refer to the dev-server documentation for more details.

Changelog

1.0.1

• (wolkeSoftware) initial release

License

MIT License

Copyright (c) 2023 wolkeSoftware [email protected]

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.