danidask / js_serial

js_serial

Bridge between javascript app and serial device
Explore the docs »

Report Bug · Request Feature

Table of Contents

• How to install
  • Prerequisites
  • Installation or upgrade
• How to use
  • Lauch Bridge
  • JavaScript library
  • Example code
• Contributing
• License
• Notes

How to install

Prerequisites

js_serial is a python module. In order to install it you'll need:

• python version 3.5 or above
• pip

TODO instructions of how to install these in each operating system

Installation or upgrade

pip install git+https://github.com/danidask/js_serial --upgrade

NOTE: If you have multiple versions of python in your machine, use a specific pip version, like pip3 or pip3.6

How to use

Lauch Bridge

js_serial -h

JavaScript library

• JavaScript library
• Templates

Example code

• Arduino

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Notes

I had problems sending websocket messages from threads, solve the with monkey patch https://github.com/miguelgrinberg/Flask-SocketIO/blob/e024b7ec9db4837196d8a46ad1cb82bc1e15f1f3/example/app.py#L30-L31 https://python-socketio.readthedocs.io/en/latest/index.html