Skip to main content

Python module to handle Arduino port serial comunication

Project description

pyArduino

PyPI License PyPI version

Welcome to the implementation of PyArduino on Python as handler for Arduino boards.

Description

pyArduino it's a library on current development to allow programmers to easy handle data and actions over Arduino hardware.

Purpose

This package allows you to automate several things:

  1. Autodetect COM or TTY port when Arduino is detected.
  2. Get info about the board, like his name, protocols, firmware versions...
  3. Handling data directly from your Python interpreter.

About

You can now use the implemented classes for friendly manage your board from Python. At 01(day)/12(month)/2020, when package it's released on his 0.1.0 version, you can send data to a 16x2 LCD Screen, being able to send strings to it throught a buffer as main feature, or get data and OPEN and CLOSE serial ports or autodetect whenever Arduino (or a copy of him it's connected.)

Download

· First of all, install Python if you're not.

· Type on your CMD or Terminal: pip install pyArduino

Wait until download finishes... and... It's ready.

NOTE: If you dont have pip package manager installated, go google it and install it.

Examples

You have a folder inside project's folder called 'examples', with current up-to-date code based on what modules are being deployed over time.

Little example

if name == 'main':

# 1st instanciate the ShowConnectionInfo Class, which autoconnect your board via Serial module
# due to inheritance properties, and will give you a full review of your board capabilities.
info = pyArduino.ShowConnectionInfo()

# This 'show_info()' method gives you back basic info about the status
info.show_info()

# Shows you current layout config of your board
info.board_config()

# if you need to get for your software how many pins you have without hardcoring the number  
total_pins = info.board_number_pins()
print(total_pins)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Credits

Libraries used here for build this project are pyfirmata and pyserial, so thanks to his creators for his hard work.

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

pyArduino-0.2.2.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

pyArduino-0.2.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file pyArduino-0.2.2.tar.gz.

File metadata

  • Download URL: pyArduino-0.2.2.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for pyArduino-0.2.2.tar.gz
Algorithm Hash digest
SHA256 0e518e7a0a975e35d4df087bd7cb00137a265f5f0291a12509d1e4a9d9f288e2
MD5 ea73620f9dbc6e78a52d106d84393857
BLAKE2b-256 b36dfc4c8f22cea7257da00c3729289075500e291764fe247e78be4fcd09e9e3

See more details on using hashes here.

File details

Details for the file pyArduino-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: pyArduino-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for pyArduino-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a21d9856d6a28349350c2aff4ae1806b8e648fed3f2ba956d822cfe7ff519720
MD5 9057a084fbef800ea63f47aec1396bae
BLAKE2b-256 dfb9452d08ecd76cb43a83c5350d3c726a6525406b7e220802ceedb356b686df

See more details on using hashes here.

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