Skip to main content

Library for interacting with UPB PIM.

Project description

Python UPB Powerline Interface library

Library for interacting with UPB PIM/CIM

https://github.com/gwww/upb-lib

Requirements

  • Python 3.7 (or higher)

Description

This package is created as a library to interact with an UPB PIM. The motivation to write this was to use with the Home Assistant automation platform. The library can be used for writing other UPB applications. The IO with the PIM is asynchronous over TCP or over the serial port.

Installation

    $ pip install upb_lib

Overview

Details TBD

Simplest thing right now is when in the root of the git repo that you have cloned is to enter the command bin/simple. You need the environment variable UPBPIM_URL set. Mine is set to serial:///dev/cu.KeySerial1 on a MacBook. What is constant is serial:// followed by the USB port that the PIM is on, which in my case is /dev/cu.KeySerial1. On Windows is might be something like COM1.

Also required is a UPStart export file. Mine is in the bin directory and named upb.upe. The simple program looks for it there.

This is all under very active development and will change. But if you really want to get up and running... Go for it!

Development

This project uses poetry for development dependencies. Installation instructions are on their website.

To get started developing:

git clone https://github.com/gwww/upb-lib.git
cd upb
poetry install
poetry shell # Or activate the created virtual environment
make test # to ensure everything installed properly

There is a Makefile in the root directory as well. The make command followed by one of the targets in the Makefile can be used. If you don't have or wish to use make the Makefile serves as examples of common commands that can be run.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

upb-lib-0.2.0.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

upb_lib-0.2.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file upb-lib-0.2.0.tar.gz.

File metadata

  • Download URL: upb-lib-0.2.0.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.4 Darwin/19.2.0

File hashes

Hashes for upb-lib-0.2.0.tar.gz
Algorithm Hash digest
SHA256 54eb081a899d776e5f84ace77dbc11feaddec6fe41a213b9f11b00938140cd87
MD5 0cd4a8e23b448026a5ceef33aad05b7b
BLAKE2b-256 9a5ea9f40398855e94de6715d1268d9fac88c761eba5060a760b83587ec20700

See more details on using hashes here.

Provenance

File details

Details for the file upb_lib-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: upb_lib-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.4 Darwin/19.2.0

File hashes

Hashes for upb_lib-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4020b7a9766891fcc8ea2bc56a5f9e26a7a4a5f7b387c2442d0f8a8a0b65cf23
MD5 6ff0c2c3e12ad154c4070382fcad4041
BLAKE2b-256 6ae08490a5280eeee7d6abf7f346b3ba743b1c90722b842164c587e81cbd131b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page