Move energy api to docusaurus

Author: DCSBL

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/changelog.md

@@ -0,0 +1,32 @@
+# API Changelog
+
+## 2023-01-24
+**SDM230-wifi** and **SDM630-wifi** now support `api/v1/system`.The Energy meter should run version 3.00 or later, the device will be updated automatically.
+
+See [Identify](/docs/endpoints/api-v1-identify.md) for more information.
+
+## 2023-01-03
+**HWE-P1** has now support for `api/v1/system` and `api/v1/identify`.The P1 meter should run version 4.00 or later, the device will be updated automatically.
+
+See [System](/docs/endpoints/api-v1-system.md) and [Identify](/docs/endpoints/api-v1-identify.md) for more information.
+
+## 2023-01-03
+Added documentation about updated `api/v1/data` endpoint. This adds support for more data points in **HWE-P1**
+
+See [Recent measurement](/docs/endpoints/api-v1-data.md)` for more information.
+
+## 2022-11-25
+Added documentation about the `api/v1/system` endpoint.
+
+See [System](/docs/endpoints/api-v1-system.md) for more information.
+
+## 2022-11-25
+Added documentation about the `api/v1/identify` endpoint.
+
+[Identify](/docs/endpoints/api-v1-identify.md) for more information.
+
+## 2022-10-19
+Data points in ``api/v1/data`` are now optional. This means that the fields in [Recent measurement](/docs/endpoints/api-v1-data.md)` won't be send if the data does not exists at all. 
+This is -for example- possible in the P1 meter; Missing data in the telegram is not send in the API. This allows us to send new additional data more easily.
+
+See [Recent measurement](/docs/endpoints/api-v1-data.md)` for more information.

docs/discovery.md

@@ -0,0 +1,44 @@
+---
+sidebar_position: 5
+---
+
+# Discovery
+The energy devices can be automatically discovered on your network, the method used for this is [Multicast DNS](https://www.ionos.com/digitalguide/server/know-how/multicast-dns/) (`mDNS`, or sometimes called `Zeroconf` or `Bonjour`). Your application can use this technology to discover the device(s) without the user having to enter the IP address.
+
+## Example scan
+The device can be found on the `_hwenergy._tcp` domain.
+```   
+   $ dns-sd -B _hwenergy._tcp .
+   Browsing for _hwenergy._tcp
+   DATE: ---Wed 13 Oct 2021---
+   14:51:03.565  ...STARTING...
+   Timestamp     A/R  Flags  if Domain  Service Type     Instance Name
+   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  energysocket-AABBCC
+   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  energysocket-DDEEFF
+   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  energysocket-001122
+   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  p1meter-334455
+   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  energymeter-667788
+   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  watermeter-ABCDEF
+```
+
+The hostname is formatted as ``<product-name>-<last 6 characters of serial>``, so devices with serial ``AABBCCDDEEFF`` the hostname is as following:
+
+| Device                  | Example hostname |
+|-------------------------|------------------|
+| P1 meter                | p1meter-DDEEFF   |
+| Energy Socket           | energysocket-DDEEFF |
+| Watermeter              | watermeter-DDEEFF |
+| kWh meter (single phase)| kwhmeter-DDEEFF |
+| kWh meter (three phase) | kwhmeter-DDEEFF |
+
+## TXT records
+
+A discovery response contains some extra data that can be used to improve the setup in your application.
+
+| Data          | Description |
+|---------------|-------------|
+| api_enabled   | '0' or '1', reflects if the API is enabled (1 means enabled) |
+| path          | Fixed to '/api/v1'. Can be used to validate that your application supports this device and API version |
+| serial        | Serial, also the MAC address. Consists of 12 hexadecimal values |
+| product_name  | A fixed, user-friendly name. This name is not the same that is set by the user in the app. |
+| product_code  | The product type, see [Supported devices](/docs/getting-started.md#supported-devices). Make sure your application can handle other values for future products |

docs/endpoints/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Endpoints",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Use the endpoints to get real-time local data from your device and control the state of the Energy Socket. Select one of the topics below to learn more about these endpoints."
+  }
+}