Giter VIP home page Giter VIP logo

pyarduino's Introduction

pyArduino

PyPI License PyPI version

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

Find it Here

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 plugged on.
  2. Get info about the board, like his name, protocols, firmware versions...
  3. Handling data directly from your Python interpreter over a Serial connection.

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.

pyarduino's People

Contributors

therustifyer avatar

Stargazers

 avatar

Watchers

 avatar

pyarduino's Issues

PLEASE add documentation

I have been sitting here for 2 hours trying to get arduino to link up to python and found this library.
but for the love of god, I can not find any docs to find what I'm supposed to do.
Please add documentation so that I don't go insane

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.