iobroker.gigaset-elements v0.4.3

ioBroker.gigaset-elements

Adapter for Gigaset Elements (https://gigaset.com/smart-home)

Requirements

• NodeJS >= 18.x
• ioBroker >= 4.x, with admin >= 5.x
• Gigaset Elements system

Installation

You can install the adapter from stable or latest/test repository (by enabling expert mode in ioBroker and install the adapter from npm). Don't install it directly from Github, this will lead to an error on adapter start ("cannot find start file").

After installation, create a new instance and configure the settings:

• Connection Settings for accessing Gigaset Elements cloud
  • email
  • password
  • authentication interval in hours, should be 6
• Polling intervals for different areas
  • events (i.e. window/door open/tilt/close) - number of seconds between polling
  • element/sensor data (i.e. temperature, humidity) - number of minutes between polling
  • system health data (green/orange/red) - number of minutes between polling

Supported elements

So far, the adapter has been tested/is known to work with the following elements, and test data is available via gigaset-elements-api:

The adapter also supports the following other devices:

Provide test data for unsupported elements

If you have other elements, or encounter event types that are not yet handled by the adapter, you can enable expert mode in ioBroker, go to the Debug tab in the adapter settings (only visible with expert mode), and use "Debug - Prepare test data" to generate test data that can be submitted as part of a github issue for this adapter to get the additional elements/event types included. Personal data like basestation or element names and ids are stripped from the generated data as far as possible.

Messages

So far, the adapter only supports messages used for testing/debugging.

Testing

Callback responses are either { response: "<message>" } if the action was sucessfull, or { error: "<error message>" } in case something went wrong.

Ping

Send a ping to the adapter, and receive a { response: "pong" }.

sendTo("gigaset-elements.0", "test", "ping", callback);

Process test data

Process test data from gigaset-elements-api. Creates base stations, elements, and processes captured test events.

sendTo("gigaset-elements.0", "test", "process-test-data", callback);

Debugging

Callback responses are either { response: object } if the action was sucessfull, or { error: "<error message>" } in case something went wrong.

Prepare test data

Load current data from the Gigaset Elements API and prepare it to be integrated as test data into gigaset-elements-api, i.e. for new events or elements that have no test data yet.

Loads basestations, elements and events from the API, reduces it to minimize the amount of data, and tries to strip personal information like names and ids from the data.

Returns the data as an { response: { bs: [], elements: [], events: [] } } object.

sendTo("gigaset-elements.0", "debug", { action: "prepare-test-data" from?: Date }, callback);

Load base station and element data

Loads and returns the raw basestation and elements data as an { response: { bs: [], elements: []} } object.

sendTo("gigaset-elements.0", "test", { action: "load-bases-elements" }, callback);

Load events

Loads events and returns an { response: { events: [] } } object.

Event data is usually available for 1 month, older data seems not to be available.

sendTo("gigaset-elements.0", "test", { action: "load-events", from: Date, to: Date }, callback);

Changelog

0.4.3 (2023-11-21)

• (matthsc) bugfix

0.4.2 (2023-11-20)

• (matthsc) downgrade typescript to fix integration tests

0.4.1 (2023-11-20)

• (matthsc) add states for batterySaverMode, momentaryPowerMeasurement (plug), setPoint (thermostat)
• (matthsc) allow to change setPoint for thermostat (experimental/untested)
• (matthsc) allow to change intrusion mode
• (matthsc) allow to trigger user alarm
• (matthsc) add info.systemHealth state
• (matthsc/dependabot) dependency updates

0.4.0 (2023-10-15)

• (matthsc) add support for plugs
• (matthsc) drop support for Node 14 and 16
• (matthsc/dependabot) dependency updates

0.3.0 (2022-09-28)

• (matthsc) drop support for Node 12 and js-controller 3
• (matthsc) implement migrations from create-adapter
• (matthsc/dependabot) dependency updates

0.2.2 (2022-09-17)

• (matthsc) fix probably_open state
• (matthsc/dependabot) dependency updates

0.2.1 (2022-07-02)

• (matthsc) add initial support for smoke detectors
• (matthsc/dependabot) dependency updates

0.2.0 (2022-04-30)

• (matthsc) add support for phones
• (matthsc) add Node 18 to test matrix
• (matthsc/dependabot) dependency updates

0.1.3 (2022-03-22)

• (matthsc) fix "unknown" element position state
• (matthsc) add more tests
• (matthsc/dependabot) dependency updates

0.1.2 (2022-02-28)

• (matthsc) fix test data generation
• (matthsc/dependabot) dependency updates

0.1.1 (2022-02-12)

• (matthsc) implement adapter review feedback

0.1.0 (2022-01-29)

• (matthsc) initial release

License

MIT License

Copyright (c) 2023 matthsc matthsc@gmx.net

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.