ambient-aprs

A Python class for sending Ambient Weather API Data as APRS packets.


Keywords
aprs, cwop, weatherstation, ambientweather, ambientweather-api
License
MIT
Install
pip install ambient-aprs==0.13.0

Documentation

PyPI Build Status codecov CodeFactor

ambient_aprs

Wrapper for ambient_api to allow sending APRS packets to CWOP

Installation

pip install ambient_aprs
Environmental Variables
AMBIENT_ENDPOINT=https://api.ambientweather.net/v1
AMBIENT_API_KEY='your-api-key-here'
AMBIENT_APPLICATION_KEY='your-application-key-here'

Get these values by following these instructions.

Classes

There is one class implemented in this module.

AmbientAPRS

This is the base Class that you initialize in your code.

from ambient_aprs.ambient_aprs import AmbientAPRS

aprs = AmbientAPRS(
    station_id='<your-station-id>',
    latitude=43.131258,
    longitude=-76.155028
)

aprs.get_weather_data()
aprs.build_packet()
result = aprs.send_packet()

You can also initialize the Class with the following keyword arguments

  • send_id - In case you want your software to identify itself as something other than "Ambient APRS"
  • host - The server you want to send your APRS packet to. (default is cwop.aprs.net)
  • port - The port you want to send your APRS packet on. (default is 14580)
    • This non-standard port is blocked on some networks.

get_weather_data() and build_packet() will also return the data they generate to a variable if specified.

weather_data = aprs.get_weather_data()
my_packet = aprs.build_packet()

The send_packet() method can also send a manually constructed APRS packet by passing it into the function.

aprs.send_packet('MY PACKET DATA')

Why?

I want to send data from my own Weather Station to CWOP without needing to pay for another piece of software.