Giter Site home page Giter Site logo

pdxlocations / meshtastic-mqtt-client Goto Github PK

View Code? Open in Web Editor NEW

This project forked from arankwende/meshtastic-mqtt-client

0.0 0.0 0.0 248 KB

This is a simple program that accesses an MQTT server in which meshtastic routers publish messages and shows them on a gui.

License: BSD 3-Clause "New" or "Revised" License

Python 100.00%

meshtastic-mqtt-client's Introduction

meshtastic-mqtt-client

This is a simple program that accesses an MQTT server in which meshtastic routers publish messages and shows them on a gui.

The decoding of the protobuf messages is based on josh pirihi's great work here: https://github.com/joshpirihi/meshtastic-mqtt

Full page

The script requires:

python and pip to be installed on the server for linux (apt):

sudo apt install python3 python3-pip

as well as the following modules with pip:

pyyaml, paho-mqtt, pySimpleGUI and protobuf :

sudo pip install pyyaml paho-mqtt pySimpleGUI protobuf

Once installed, just copy this repo (you can use git clone), complete the YAML file and rename it config.yaml in the /config/ folder, make the script executable and run it (chmod +x meshtastic-mqtt-client.py and ./meshtastic-mqtt-client.py).There's an example config file (config - example.yaml), you can directly modify and rename it config.yaml. It must contain:

An MQTT configuration with IP, user, password, otherwise it will run until:

MQTT:
    MQTT_ip: MQTT BROKER IP
    MQTT_USER: 'MQTT user'
    MQTT_PW: 'MQTTPASSWORD'

Your Meshtastic configuration, basically channel id, client id and gateway id, as well as the information your client will provide to the network, a client full ID, a long name to identify you, a short name (3 characters) and a mac address:

MESHTASTIC:
    CHANNEL_ID: 'ShortFast' # the name of your channel
    CLIENT_ID: '12345678' #the id for your program to use
    GATEWAY_ID: '!12345678' # Your gateway's id
    CLIENT_FULL_ID: '!12345678'
    LONG_NAME: 'FULL_NAME'
    SHORT_NAME: 'TEST'
    MACADDR: '000000000000'

And you're set.

meshtastic-mqtt-client's People

Contributors

arankwende avatar pdxlocations avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.