aioptdevices 2025.12.4

No project description provided

aioptdevices

Easily fetch your PTDevice information from the PTDevices servers with the aioptdevices package.

Table of Contents

1. About This Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About This Project

This package allows polling the PTDevices servers for device data via the token API. See Token API Docs. It was developed for use in the PTDevices Home Assistant Integration but can be used for other projects. It offers both a command line tool and a library.

(back to top)

Getting Started

Prerequisites

• Have Python 3.12 or later installed.
• Have a PTDevices account and an API token. You can request a free API token by creating a support ticket at https://support.paremtech.com/portal/en/newticket. To help streamline the process, be sure to include the email address associated with your PTDevices account.

Installation

PyPi

python3 -m pip install aioptdevices

Manual Setup

1. Clone the repository.

   git clone https://github.com/ParemTech-Inc/aioptdevices.git
   

2. Install Python Packages and setup the environment.

   Linux venv Setup

   bash ./setup.sh
   source venv/bin/activate
   

   Windows venv Setup

   .\setup.ps1
   .\venv\Scripts\activate
   

   Installing Globally

   Linux and Windows

   python3 -m pip install .
   

(back to top)

Usage

As a Command Line Tool

Make sure to set up and activate the venv or install the package globally before trying to use it, refer to Manual setup step 2. If you installed the package from PyPi, you can go straight to Command usage.

Command usage

usage: aioptdevices [-h] [-U URL] [-D] deviceID authToken

positional arguments:
  deviceID
  authToken

options:
  -h, --help         show this help message and exit
  -U URL, --url URL
  -D, --debug

As a Library

See the examples folder for usage as a library.

(back to top)

Contributing

If you have an idea to improve this package, please fork the repo and create a pull request. Or, you can simply open an issue.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Create ./tests/secret.py with

"""Secret Parameters."""

TOKEN: str = "Your API Token"
DEVICE_ID: str = "Your Device ID"

5. Run pytest and verify that all tests pass
6. Push to the Branch (git push origin feature/AmazingFeature)
7. Open a Pull Request

(back to top)

License

Distributed under the GNU GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Matthew Gibson - @frogman85978 - [e-mail]

ParemTech Inc. - @ParemTech-Inc - [e-mail]

Project Link: https://github.com/ParemTech-Inc/aioptdevices

(back to top)

Acknowledgments

• Othneil Drew (@othneildrew) creator of the Best-README-Template
• Robert Svensson (@Kane610) creator of the aiounifi package

(back to top)