https://github.com/matteosox/pysparkplug

An open-source, Python implementation of Sparkplug B, an MQTT topic and payload definition standard
https://github.com/matteosox/pysparkplug

automation manufacturing mqtt sparkplug

Last synced: 4 months ago
JSON representation

An open-source, Python implementation of Sparkplug B, an MQTT topic and payload definition standard

• Host: GitHub
• URL: https://github.com/matteosox/pysparkplug
• Owner: matteosox
• License: apache-2.0
• Created: 2023-07-26T22:58:22.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-14T02:54:47.000Z (over 1 year ago)
• Last Synced: 2024-03-15T04:47:47.474Z (over 1 year ago)
• Topics: automation, manufacturing, mqtt, sparkplug
• Language: Python
• Homepage: https://pysparkplug.mattefay.com
• Size: 229 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# **PySparkplug**: Sparkplug B for Python

[![CI/CD: n/a](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml/badge.svg)](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml)

[![Docs: n/a](https://readthedocs.org/projects/pysparkplug/badge/?version=stable)](https://pysparkplug.mattefay.com)

[![Downloads: n/a](https://static.pepy.tech/personalized-badge/pysparkplug?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/pysparkplug)

[![PyPI: n/a](https://img.shields.io/badge/dynamic/json?color=blueviolet&label=PyPI&query=%24.info.version&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fpysparkplug%2Fjson)](https://pypi.org/project/pysparkplug/)

[![codecov: n/a](https://codecov.io/gh/matteosox/pysparkplug/branch/main/graph/badge.svg?token=8VKKDG9SMZ)](https://codecov.io/gh/matteosox/pysparkplug)

## Getting Started

### Installation

`pysparkplug` is a pip-installable package [hosted on PyPI](https://pypi.org/project/pysparkplug/). Getting started is as easy as:

```console

$ pip install pysparkplug

```

`pysparkplug` uses the Eclipse Paho™ MQTT Python Client, i.e. [`paho-mqtt`](https://github.com/eclipse/paho.mqtt.python), for low-level MQTT communication.

### Usage

Simple demos of the `EdgeNode`, `Device`, and `Client` classes publishing and subscribing all supported payloads and metric datatypes can be found in the `notebooks` directory. To run them dynamically, you'll need to install Docker and run `just notebooks` before opening up your local browser to http://localhost:8888. The password is `bokchoy`.

## Features

### Fully type annotated

`pysparkplug`'s various interfaces are fully type annotated.