Package 'microinverterdata'

Title: Collect your Microinverter Data
Description: Collect and normalize local microinverter energy and power production data through off-cloud API requests. Currently supports 'APSystems' microinverters.
Authors: Christophe Regouby [aut, cre, cph]
Maintainer: Christophe Regouby <[email protected]>
License: MIT + file LICENSE
Version: 0.1.0.9000
Built: 2024-10-04 18:24:28 UTC
Source: https://github.com/camembr/microinverterdata

Help Index

Get inverter device alarms

Description

Get inverter device alarms

Usage

get_alarm(device_ip, model = "APSystems")

Arguments

device_ip

list or vector of devices IP address
model

the inverter device model. Currently only "APSystems" is supported.

Value

a dataframe with one row of device information per 'device_id' answering the query.

Examples

## Not run: 
get_alarm(c("192.168.0.12", "192.168.0.230"))

## End(Not run)

Get inverter device information

Description

Get inverter device information

Usage

get_device_info(device_ip, model = "APSystems")

Arguments

device_ip

list or vector of devices IP address
model

the inverter device model. Currently only "APSystems" is supported.

Value

a data-frame with one row of device information per 'device_id' answering the query.

Examples

## Not run: 
get_device_info(c("192.168.0.12", "192.168.0.230"))

## End(Not run)

Get inverter output data

Description

Get inverter output data

Usage

get_output_data(device_ip, model = "APSystems")

Arguments

device_ip

list or vector of devices IP address
model

the inverter device model. Currently only "APSystems" is supported.

Value

a dataframe with one row of device output power and energy per 'device_id' / 'inverter' combination.

Examples

## Not run: 
get_output_data(c("192.168.0.12", "192.168.0.230"))

## End(Not run)

AP System single device query

Description

AP System single device query

Usage

query_ap_device(device_ip, query)

Arguments

device_ip

IP address of the APSystem device
query

the API query string

Value

a data-frame with a 'device_id' column and the '$data' turned into as many columns as expected

Examples

## Not run: 
query_ap_device(device_ip = "192.168.0.234", query = "getDeviceInfo")

## End(Not run)

AP System multi-device query

Description

AP System multi-device query

Usage

query_ap_devices(device_ip, query)

Arguments

device_ip

list or vector of each APSystem device IP address
query

the API query string

Value

a data-frame with a row for each 'device_id', and the '$data' turned into as many columns as expected

Examples

## Not run: 
query_ap_devices(device_ip = c("192.168.0.234", "192.168.0.235"),
                 query = "getDeviceInfo"
                 )

## End(Not run)