microinverterdata

Collect your microinverter data

https://github.com/camembr/microinverterdata

Repository

Collect your microinverter data

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# microinverterdata



[![R-CMD-check](https://github.com/CamembR/microinverterdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CamembR/microinverterdata/actions/workflows/R-CMD-check.yaml) 
[![Lifecycle:experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![CRAN status](https://www.r-pkg.org/badges/version/microinverterdata)](https://CRAN.R-project.org/package=microinverterdata) [![](https://cranlogs.r-pkg.org/badges/microinverterdata)](https://cran.r-project.org/package=microinverterdata)



The goal of microinverterdata is to provide access to your local micro-inverter data.

## Installation

You can install the released version from CRAN with:

``` r
install.packages("microinverterdata")
```

Or you can install the development version of {microinverterdata} from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("CamembR/microinverterdata")
```

## Example

This is a basic example to get inverter data for a single device:

```{r example}
library(microinverterdata)

## single micro-inverter device data
get_output_data(device_ip = "192.168.0.75")

```

The single device here includes 2 separated inverters. We get one row of data per inverter, i.e. per solar panel.

You can also use a vector of IP addresses for `device_ip`. Thus the command would run on all the inverters in parallel.

```{r multiple_inverters}
## multiple inverters data
get_output_data(device_ip = c("192.168.0.75", "192.168.0.186"))

```

The packages also gives access to inverter information through `get_device_info()` and inverter internal alarms through `get_alarm()`.

## Microinverter support and configuration

The package allow querying values on diverse device models through the `model = "..."` parameter.

{microinverterdata} may require a minimal software version and configuration for the supported inverters :

| Inverter Manufacturer | Inverter Model | Firmware version | Configuration |
|------------------|------------------|------------------|------------------|
| APSystems | EZ1 | ≥ 1.7.0 | [Continuous local mode](https://camembr.github.io/microinverterdata/articles/APSystems_devices.html) (off-cloud)|
| Fronius | multiple | ≥ 1.7.2 | off-cloud (Need testers)          |
| Enphase | Envoy-S  | D5.x.x  | off-cloud (Need testers)          |
| Enphase | Energy   | < 7.x   | off-cloud (Need testers)          |

## Contributing

No matter your current skills, it’s possible to contribute to microinverterdata development. We welcome all kinds of contributions, from correcting typos via bug fixes to feature additions.

### Fixing typos

To fix typos, spelling mistakes, or grammatical errors, you need to make changes in the source .R file in question, not in the generated .Rd file. 

### Filing bugs

If you find a bug in microinverterdata, please open an New issue [here](https://github.com/CamembR/microinverterdata/issues). Please provide detailed information on your microinverter (model, version, ) . It would be great to also provide a link to the documentation of its API.

### Feature requests / New model support

Feel free to open a New issue [here](https://github.com/CamembR/microinverterdata/issues), and add the feature-request tag. Also try searching if there’s already an open issue for your feature-request – in this case it’s better to comment or upvote it instead of opening a new one.

Owner

GitHub Events

Issues and Pull Requests

Last synced: 9 months ago

Packages