diff --git a/README.md b/README.md index 95f27c8..2fa8609 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# HomeWizard Energy - Local API Documentation +# HomeWizard - Local API Documentation -The HomeWizard Energy devices are equipped with a local API. This API can be used to read out the data from the device and to control the device. This documentation describes the API and how to use it. +The HomeWizard devices are equipped with a local API. This API can be used to read out the data from the device and to control the device. This documentation describes the API and how to use it. > [!TIP] -> Visit [api-documentation.homewizard.com](https://api-documentation.homewizard.com) to learn everything about the HomeWizard Energy API. +> Visit [api-documentation.homewizard.com](https://api-documentation.homewizard.com) to learn everything about the HomeWizard API. ## Contributing diff --git a/docs/changelog.mdx b/docs/changelog.mdx index 2b7fd6b..6d71036 100644 --- a/docs/changelog.mdx +++ b/docs/changelog.mdx @@ -27,7 +27,7 @@ Feature development of the v1 API has been stopped. No new features will be adde #### 2.0.1 - 30-01-2025 -- An issue has been resolved where `energy_import_kwh` and `energy_export_kwh` values in the Plug-In Battery [Measurement API](/docs/v2/measurement#plug-in-battery-hwe-bat) were returning invalid values. The values are now the same as those in the HomeWizard Energy app. +- An issue has been resolved where `energy_import_kwh` and `energy_export_kwh` values in the Plug-In Battery [Measurement API](/docs/v2/measurement#plug-in-battery-hwe-bat) were returning invalid values. The values are now the same as those in the HomeWizard app. #### 2.1.0 - 01-05-2025 diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 4f0ac4e..f80db0e 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -7,11 +7,11 @@ import Link from '@docusaurus/Link' # Getting Started. -This guide will help you get started with the HomeWizard Energy API. +This guide will help you get started with the HomeWizard API. ## Choosing the Right API Version. -The HomeWizard Energy API has two versions: v1 and v2. The v1 API is available as long as feasible, but will be phased out. The v2 API is the stable version and is recommended to be used. Skip to [getting started with v2](#getting-started-with-v2) if you want to use the v2 API. +The HomeWizard API has two versions: v1 and v2. The v1 API is available as long as feasible, but will be phased out. The v2 API is the stable version and is recommended to be used. Skip to [getting started with v2](#getting-started-with-v2) if you want to use the v2 API. [Review the device compatibility table](/docs/introduction#devices) to check which API versions are supported for your specific hardware before choosing your version. @@ -19,11 +19,11 @@ The HomeWizard Energy API has two versions: v1 and v2. The v1 API is available a ### 1. Connect your Device to Wi-Fi -Connect your Device to Wi-Fi with the HomeWizard Energy App. Make sure to connect your device with the same network as the device that makes use of the API. +Connect your Device to Wi-Fi with the HomeWizard app. Make sure to connect your device with the same network as the device that makes use of the API. ### 2. Enable the API -To access the data from an Energy device, you have to enable the API. You can do this in the HomeWizard Energy app. Go to Settings → Meters → _Your meter_, and turn on _Local API_. +To access the data from an Energy device, you have to enable the API. You can do this in the HomeWizard app. Go to Settings → Meters → _Your meter_, and turn on _Local API_. ### 3. Get a Measurement @@ -43,7 +43,7 @@ The following example will show you can use the API to get basic information. ### 1. Connect your Device to Wi-Fi -Connect your device to Wi-Fi with the HomeWizard Energy app. Make sure to connect your device with the same network as the device that makes use of the API. +Connect your device to Wi-Fi with the HomeWizard app. Make sure to connect your device with the same network as the device that makes use of the API. ### 2. Get a Token diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 8229b98..eebd3ec 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -8,21 +8,21 @@ import Badge from '@site/src/components/Badge.js' # Introduction. -With the HomeWizard Energy platform, you can gain insights into your energy usage. Use the HomeWizard P1 Meter to access real-time data directly from your smart meter, the HomeWizard Energy Socket to get energy insights from all your devices, the HomeWizard kWh Meter to measure devices such as solar panels, and the HomeWizard Water Meter to gain insights into your water usage. With the open API, you can integrate the data directly into your system of choice. +With the HomeWizard platform, you can gain insights into your energy usage. Use the HomeWizard P1 Meter to access real-time data directly from your smart meter, the HomeWizard Energy Socket to get energy insights from all your devices, the HomeWizard kWh Meter to measure devices such as solar panels, and the HomeWizard Watermeter to gain insights into your water usage. With the open API, you can integrate the data directly into your system of choice. -## HomeWizard Energy API. +## HomeWizard API. -The HomeWizard P1 Meter, Energy Socket, kWh Meter, Watermeter, and Plug-In Battery (referred to as "device") each have a local API that allows you to retrieve the latest measurements or control the device. You can access this API as long as you are connected to the same Wi-Fi network as the device and the API is enabled in the HomeWizard Energy app. This API is designed for integrating your device with personal automation, home automation, or data graphing systems. It is not possible to retrieve historical data through the local API, as this data is not stored on the device itself. +The HomeWizard P1 Meter, Energy Socket, kWh Meter, Watermeter, and Plug-In Battery (referred to as "device") each have a local API that allows you to retrieve the latest measurements or control the device. You can access this API as long as you are connected to the same Wi-Fi network as the device and the API is enabled in the HomeWizard app. This API is designed for integrating your device with personal automation, home automation, or data graphing systems. It is not possible to retrieve historical data through the local API, as this data is not stored on the device itself. ## Terms and Conditions. -- **License** - The HomeWizard Energy API is licensed, not sold. HomeWizard grants the user a non-exclusive license (with no right to sub-license) to the HomeWizard Energy API for personal, non-commercial use. -- **Usage** - The user may not directly or indirectly use the HomeWizard Energy API to sell, lease, loan or generate a revenue from a product, system or software using the API -- **Support** - The usage of the HomeWizard Energy API is officially supported by HomeWizard, however HomeWizard can not supply customer service regarding the implementation of the API in your own or third party applications. +- **License** - The HomeWizard API is licensed, not sold. HomeWizard grants the user a non-exclusive license (with no right to sub-license) to the HomeWizard API for personal, non-commercial use. +- **Usage** - The user may not directly or indirectly use the HomeWizard API to sell, lease, loan or generate a revenue from a product, system or software using the API +- **Support** - The usage of the HomeWizard API is officially supported by HomeWizard, however HomeWizard can not supply customer service regarding the implementation of the API in your own or third party applications. ## API v2. -The HomeWizard Energy API is moving to v2, which is a more secure and feature-rich version of the API. In v2 of the API, we have added the following features: +The HomeWizard API is moving to v2, which is a more secure and feature-rich version of the API. In v2 of the API, we have added the following features: - **HTTPS** - Your data is securely transmitted. - **Always available** - No need to turn on the API in the app. diff --git a/docs/v1/system.mdx b/docs/v1/system.mdx index a9d343e..285b1e9 100644 --- a/docs/v1/system.mdx +++ b/docs/v1/system.mdx @@ -24,7 +24,7 @@ The `/api/v1/system` endpoint can be used to configure system settings. Currentl ## Enable Cloud. -The HomeWizard Energy devices are designed to work with the HomeWizard Energy app and require communication with the HomeWizard cloud to make them function with the app. +The HomeWizard devices are designed to work with the HomeWizard app and require communication with the HomeWizard cloud to make them function with the app. The `Enable cloud` configuration feature can be used to turn off all communication with the HomeWizard cloud, making the device fully local. The device cannot communicate with the app, and the device won't receive any future firmware updates. diff --git a/docs/v2/authorization.mdx b/docs/v2/authorization.mdx index acab29c..0f0e38f 100644 --- a/docs/v2/authorization.mdx +++ b/docs/v2/authorization.mdx @@ -1,7 +1,7 @@ --- title: Authorization sidebar_position: 1 -description: Get a token to authenticate requests to the HomeWizard Energy API. +description: Get a token to authenticate requests to the HomeWizard API. --- import Badge from '@site/src/components/Badge.js' @@ -20,7 +20,7 @@ import Badge from '@site/src/components/Badge.js' --- -The HomeWizard Energy API requires a Bearer token to authorize requests. This token should be included in the `Authorization` header of each request. To get a token you must create a user on the device. +The HomeWizard API requires a Bearer token to authorize requests. This token should be included in the `Authorization` header of each request. To get a token you must create a user on the device. ## Create User and get Token. @@ -206,7 +206,7 @@ Content-Length: 0 ## Local and Cloud Users. -The local API is used by HomeWizard to enable direct communication between HomeWizard devices on a local network. To simplify setup for non-technical users, tokens can also be generated via the HomeWizard Energy app or background process using the cloud. +The local API is used by HomeWizard to enable direct communication between HomeWizard devices on a local network. To simplify setup for non-technical users, tokens can also be generated via the HomeWizard app or background process using the cloud. - Cloud-generated users are prefixed with `cloud/`, local users are prefixed with `local/`. - These tokens are for local device communication only and do not provide access to the cloud nor can be used by the cloud itself. diff --git a/docs/v2/batteries.mdx b/docs/v2/batteries.mdx index 0d81520..48ef4c8 100644 --- a/docs/v2/batteries.mdx +++ b/docs/v2/batteries.mdx @@ -13,7 +13,7 @@ import Badge from '@site/src/components/Badge.js' Energy Socket Energy Display kWh Meter -Water Meter +Watermeter Plug-In Battery
_See [Supported Devices](/docs/introduction#devices) for more information._ diff --git a/docs/v2/error-handling.mdx b/docs/v2/error-handling.mdx index 9127c5d..48233de 100644 --- a/docs/v2/error-handling.mdx +++ b/docs/v2/error-handling.mdx @@ -1,7 +1,7 @@ --- title: Error Handling sidebar_position: 7 -description: Learn how to handle errors when using the HomeWizard Energy API. +description: Learn how to handle errors when using the HomeWizard API. --- import Badge from '@site/src/components/Badge.js' diff --git a/docs/v2/system.mdx b/docs/v2/system.mdx index 05cc0d8..0147c90 100644 --- a/docs/v2/system.mdx +++ b/docs/v2/system.mdx @@ -54,7 +54,7 @@ The battery is fully controlled locally by the P1 Meter, ensuring fast operation ## Cloud Communication. -HomeWizard Energy devices are designed to work with the HomeWizard Energy app and rely on communication with the HomeWizard cloud for full functionality. +HomeWizard devices are designed to work with the HomeWizard app and rely on communication with the HomeWizard cloud for full functionality. Users can choose to disable cloud communication, making the device operate entirely locally. However, this will prevent the app from interacting with the device, and the device will no longer receive firmware updates. @@ -180,7 +180,7 @@ Content-Type: application/json } ``` -_The v1 API is now disabled, as if it was disabled via the HomeWizard Energy app. The v1 API will respond with an [API disabled error](/docs/v1/error-handling#api-was-disabled) when trying to use it._ +_The v1 API is now disabled, as if it was disabled via the HomeWizard app. The v1 API will respond with an [API disabled error](/docs/v1/error-handling#api-was-disabled) when trying to use it._ ## Identify. diff --git a/docs/v2/websocket.mdx b/docs/v2/websocket.mdx index dcec5ca..f7621e4 100644 --- a/docs/v2/websocket.mdx +++ b/docs/v2/websocket.mdx @@ -21,7 +21,7 @@ import Badge from '@site/src/components/Badge.js' --- -The HomeWizard Energy WebSocket API allows you to receive real-time updates from the device. The WebSocket lets you subscribe to specific topics and receive updates when data changes. +The HomeWizard WebSocket API allows you to receive real-time updates from the device. The WebSocket lets you subscribe to specific topics and receive updates when data changes. ## Structure. diff --git a/docs/versioning.mdx b/docs/versioning.mdx index 85f1187..8ebd2d1 100644 --- a/docs/versioning.mdx +++ b/docs/versioning.mdx @@ -9,7 +9,7 @@ import Link from '@docusaurus/Link' ## Version Scheme. -The HomeWizard Energy API follows [semantic versioning](https://semver.org/), with the version number structured as `MAJOR.MINOR.PATCH`. The v1 API only uses the `MAJOR` version, while the v2 API uses both `MAJOR` and `MINOR`. +The HomeWizard API follows [semantic versioning](https://semver.org/), with the version number structured as `MAJOR.MINOR.PATCH`. The v1 API only uses the `MAJOR` version, while the v2 API uses both `MAJOR` and `MINOR`. - `MAJOR` version updates signal incompatible changes in the API. - `MINOR` version updates add backward-compatible features or enhancements. @@ -17,7 +17,7 @@ The HomeWizard Energy API follows [semantic versioning](https://semver.org/), wi ### Backward Compatibility -The HomeWizard Energy API is designed for backward compatibility, aiming to avoid breaking changes. When a breaking change is necessary, the `MAJOR` version number will increase, while the original API remains accessible. See [Requesting a Specific API Version](#requesting-a-specific-api-version) for more information. +The HomeWizard API is designed for backward compatibility, aiming to avoid breaking changes. When a breaking change is necessary, the `MAJOR` version number will increase, while the original API remains accessible. See [Requesting a Specific API Version](#requesting-a-specific-api-version) for more information. An older version remain available as long as feasible, but may be removed at any time. To stay informed, [subscribe to updates](/docs/changelog#subscribe-to-updates). diff --git a/docusaurus.config.js b/docusaurus.config.js index 7563ebe..7efd2b0 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -8,7 +8,7 @@ import { themes as prismThemes } from 'prism-react-renderer' /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'HomeWizard Energy API Documentation', + title: 'HomeWizard API Documentation', favicon: 'img/favicon.ico', // Set the production url of your site here @@ -54,7 +54,7 @@ const config = { navbar: { title: 'API Documentation', logo: { - alt: 'HomeWizard Energy Logo', + alt: 'HomeWizard Logo', src: 'img/logo.svg' }, items: [ diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js index 510e92c..282b524 100644 --- a/src/components/HomepageFeatures/index.js +++ b/src/components/HomepageFeatures/index.js @@ -9,7 +9,7 @@ const FeatureList = [ title: 'Local.', description: ( <> - The HomeWizard Energy API is available on your local network. This means that you can use it without an internet connection. You can even turn off the connection with the cloud. + The HomeWizard API is available on your local network. This means that you can use it without an internet connection. You can even turn off the connection with the cloud. ) }, diff --git a/src/pages/index.js b/src/pages/index.js index d278dae..c6ea84a 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -13,7 +13,7 @@ function HomepageHeader() { Local API Documentation -

Control your HomeWizard Energy devices with the Local API.

+

Control your HomeWizard devices with the Local API.

Get started @@ -26,7 +26,7 @@ function HomepageHeader() { export default function Home() { return ( - +