iobroker.nibe-rest-api 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maximilian Kramer <maxi_kramer@web.de>
+
+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.

package/README.md

@@ -0,0 +1,192 @@
+![Logo](admin/nibe-rest-api-wide.png)
+
+# ioBroker.nibe-rest-api
+
+[![NPM version](https://img.shields.io/npm/v/iobroker.nibe-rest-api.svg)](https://www.npmjs.com/package/iobroker.nibe-rest-api)
+[![Downloads](https://img.shields.io/npm/dm/iobroker.nibe-rest-api.svg)](https://www.npmjs.com/package/iobroker.nibe-rest-api)
+![Number of Installations](https://iobroker.live/badges/nibe-rest-api-installed.svg)
+![Current version in stable repository](https://iobroker.live/badges/nibe-rest-api-stable.svg)
+
+[![NPM](https://nodei.co/npm/iobroker.nibe-rest-api.png?downloads=true)](https://nodei.co/npm/iobroker.nibe-rest-api/)
+
+**Tests:** ![Test and Release](https://github.com/maxik690/ioBroker.nibe-rest-api/workflows/Test%20and%20Release/badge.svg)
+
+## nibe-rest-api adapter for ioBroker
+
+Read and write datapoints of your Nibe Heatpump via REST API (integrated from Firmware 4.6.4). Developed with my Nibe S1155.
+
+## Configuration
+
+Configure the adapter with the URL of your local NIBE API, for example `https://192.168.2.107:8443`.
+
+- `Username` and `Password`: Used for HTTP Basic authentication.
+- `Basic auth hash`: Optional alternative to username/password. If set, it is sent directly after `Basic `.
+- `Poll interval`: Refresh interval in seconds.
+- `Device IDs`: Optional comma-separated device indexes or serial numbers. Empty means all devices.
+- `Ignore TLS certificate errors`: Helpful for local/self-signed HTTPS certificates.
+- `Fetch notifications`: Reads active alarms and exposes them as JSON.
+
+## Object structure
+
+The adapter creates one channel per detected device:
+
+- `devices.<serial>.aidMode`
+- `devices.<serial>.smartMode`
+- `devices.<serial>.product.*`
+- `devices.<serial>.points.<pointId>.value`
+- `devices.<serial>.points.<pointId>.isOk`
+- `devices.<serial>.notifications.activeCount`
+- `devices.<serial>.notifications.json`
+
+Writable values from the NIBE API are exposed as writable ioBroker states. Writing to those states sends the change back to the local REST API.
+
+## Developer manual
+
+This section is intended for the developer. It can be deleted later.
+
+### 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. Create a new repository on GitHub with the name `ioBroker.nibe-rest-api`
+
+1. Push all files to the GitHub repo. The creator has already set up the local repository for you:
+    ```bash
+    git push origin main
+    ```
+1. Add a new secret under https://github.com/maxik690/ioBroker.nibe-rest-api/settings/secrets. It must be named `AUTO_MERGE_TOKEN` and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens.
+
+1. Head over to [src/main.ts](src/main.ts) and start programming!
+
+### Best Practices
+
+We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-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 :)
+
+### State Roles
+
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
+### Scripts in `package.json`
+
+Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
+| Script name | Description |
+|-------------|-------------|
+| `build` | Compile the TypeScript sources. |
+| `watch` | Compile the TypeScript sources and watch for changes. |
+| `test:ts` | Executes the tests you defined in `*.test.ts` 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`](https://github.com/ioBroker/adapter-dev#manage-translations) for more details. |
+| `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. |
+
+### Configuring the compilation
+
+The adapter template uses [esbuild](https://esbuild.github.io/) to compile TypeScript and/or React code. You can configure many compilation settings
+either in `tsconfig.json` or by changing options for the build tasks. These options are described in detail in the
+[`@iobroker/adapter-dev` documentation](https://github.com/ioBroker/adapter-dev#compile-adapter-files).
+
+### 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:
+
+```bash
+npm run release
+```
+
+Additional command line options for the release script are explained in the
+[release-script documentation](https://github.com/AlCalzone/release-script#command-line).
+
+To get your adapter released in ioBroker, please refer to the documentation
+of [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories#requirements-for-adapter-to-get-added-to-the-latest-repository).
+
+### Test the adapter manually with dev-server
+
+Since you set up `dev-server`, you can use it to run, test and debug your adapter.
+
+You may start `dev-server` by calling from your dev directory:
+
+```bash
+dev-server watch
+```
+
+The ioBroker.admin interface will then be available at http://localhost:undefined/
+
+Please refer to the [`dev-server` documentation](https://github.com/ioBroker/dev-server#command-line) for more details.
+
+## Acknowledgements
+
+Special thanks to Matthias Kleine from haus-automatisierung.com for inspiration and valuable input around ioBroker and other home automation topics and to OpenAI Codex for support during development.
+
+## Changelog
+
+<!--
+    Placeholder for the next version (at the beginning of the line):
+    ### **WORK IN PROGRESS**
+-->
+### 0.0.3 (2026-03-21)
+
+- (Maximilian Kramer) bump minor version
+
+### 0.0.2 (2026-03-21)
+
+- (Maximilian Kramer) initial release
+
+## License
+
+MIT License
+
+Copyright (c) 2026 Maximilian Kramer <maxi_kramer@web.de>
+
+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.
+
+## Trademark Notice
+
+NIBE® and the NIBE logo are trademarks of NIBE AB.
+
+This ioBroker adapter is an independent project and is not affiliated with,
+sponsored by, or endorsed by NIBE AB.
+
+The logo is used for identification purposes only.