https://github.com/fgheysels/homewizard-api-client

A library for easily consuming the Homewizard Energy API in .NET
https://github.com/fgheysels/homewizard-api-client

homewizard homewizard-energy homewizard-energy-api homewizard-p1-meter

Last synced: 20 days ago
JSON representation

A library for easily consuming the Homewizard Energy API in .NET

• Host: GitHub
• URL: https://github.com/fgheysels/homewizard-api-client
• Owner: fgheysels
• Created: 2024-02-28T22:32:50.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-02-29T22:01:32.000Z (10 months ago)
• Last Synced: 2024-11-10T22:46:27.439Z (about 1 month ago)
• Topics: homewizard, homewizard-energy, homewizard-energy-api, homewizard-p1-meter
• Language: C#
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Fg.HomeWizard.EnergyApi.Client

[![Build Status](https://frederikgheysels.visualstudio.com/GitHub%20Pipelines/_apis/build/status%2FHomewizard.Api.Client%2FHomewizard.Api.Client%20CI?branchName=main)](https://frederikgheysels.visualstudio.com/GitHub%20Pipelines/_build/latest?definitionId=11&branchName=main)

[![NuGet Badge](https://buildstats.info/nuget/fg.homewizard.energyapi.client?includePreReleases=true)](https://www.nuget.org/packages/fg.homewizard.energyapi.client/)

This library offers an easy integration with the HomeWizard Energy API.

It is available via NuGet and can be installed via:

# Installation

```

PM> Install-Package Fg.HomeWizard.EnergyApi.Client

```

# Usage

To be able to retrieve data that is exposed by your HomeWizard P1 device, you first need to know the hostname of your P1 meter.  When your P1 meter is connected with your network, you'll be able to find the hostname in your _Host Clients_ list in your router.  For instance:

![host clients](./static/img/hostlist.png)

Find your `HomeWizardDevice` in your network using its hostname with the `HomewizardDeviceResolver`:

```csharp

HomeWizardDevice device = 

    await HomeWizardDeviceResolver.FindHomeWizardDeviceAsync("p1meter-015AB0", logger);

```

> Notice that you need to remove the `HW-` part of the hostname.

Once the device has been found, you can instantiate a `HomeWizardService` instance and read out the last readings via the code below:

```csharp

HomeWizardService service = new HomeWizardService(device);

Measurement currentMeasurement = await service.GetCurrentMeasurementsAsync();

```