Skip to content

homewizard/api-documentation

Repository files navigation

HomeWizard Energy - 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.

Tip

Visit api-documentation.homewizard.com to learn everything about the HomeWizard Energy API.

Contributing

This website is built using Docusaurus 2, a modern static website generator. This project is developed and tested with Node 20.9.0

Installation

$ npm install
$ pre-commit install

While not required, we recommend you to check commits using pre-commit. This is a tool to make sure all required checks pass before committing your changes.

Local Development

$ npm 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

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Submit changes

You are always free to open issues and/or pull requests to improve this documentation.