PurpleAirLocalAPI module

Provides direct access to PurpleAir sensors on the local network without requiring API keys. This allows for faster queries and avoids cloud API rate limiting.

Usage Example

from purpleair_api.PurpleAirLocalAPI import PurpleAirLocalAPI

# Initialize with local sensor IP addresses
local_api = PurpleAirLocalAPI(ipv4_address=["192.168.1.100", "192.168.1.101"])

# Request data from local sensor
sensor_data = local_api.request_local_sensor_data()

API Reference

Copyright 2024 carlkidcrypto, All rights reserved. A python3 class designed to fetch data from Purple Air’s new API. This class will handle all local requests https://api.purpleair.com/#api-welcome

class PurpleAirLocalAPI.PurpleAirLocalAPI(ipv4_address_list=None)

Bases: object

The PurpleAirLocalAPI class designed to send valid local network requests. It can work with one or many IPv4 addresses.

Parameters:

ipv4_address_list (list) – A list of strings with valid IPv4 addresses for your sensors. The addresses don’t need a CIDR.

request_local_sensor_data() → dict

A method to request a local sensors data. This sensor must be in a netork that is accessible