https://github.com/homewizard/api-documentation

Official local API documentation for HomeWizard Energy products.
https://github.com/homewizard/api-documentation

api dsmr homewizard homewizard-energy

Last synced: about 1 month ago
JSON representation

Official local API documentation for HomeWizard Energy products.

• Host: GitHub
• URL: https://github.com/homewizard/api-documentation
• Owner: homewizard
• Created: 2023-11-13T20:29:58.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-21T11:56:45.000Z (2 months ago)
• Last Synced: 2024-10-21T17:07:57.214Z (2 months ago)
• Topics: api, dsmr, homewizard, homewizard-energy
• Language: JavaScript
• Homepage: https://api-documentation.homewizard.com
• Size: 551 KB
• Stars: 11
• Watchers: 4
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://api-documentation.homewizard.com) to learn everything about the HomeWizard Energy API.

## Contributing

This website is built using [Docusaurus 2](https://docusaurus.io/), 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](https://pre-commit.com). 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.