https://github.com/littledivy/arpyino

A simple and really tiny package to communicate with your Arduino development board.
https://github.com/littledivy/arpyino

arduino pip pip3 python python3 serial

Last synced: 4 days ago
JSON representation

A simple and really tiny package to communicate with your Arduino development board.

• Host: GitHub
• URL: https://github.com/littledivy/arpyino
• Owner: littledivy
• License: mit
• Created: 2020-03-27T09:56:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-04-30T09:26:32.000Z (over 4 years ago)
• Last Synced: 2024-09-26T01:08:39.102Z (8 days ago)
• Topics: arduino, pip, pip3, python, python3, serial
• Language: Python
• Homepage: https://pypi.org/project/arpyino/0.1/
• Size: 6.84 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Arpyino

[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)

[![PyPI version fury.io](https://badge.fury.io/py/arpyino.svg)](https://pypi.python.org/pypi/arpyino/)

[![PyPI license](https://img.shields.io/pypi/l/arpyino.svg)](https://pypi.python.org/pypi/arpyino/)

[![Only some bytes!](https://badge-size.herokuapp.com/divy-work/arpyino/master/arpyino/main.py)](https://github.com/divy-work/arpyino/blob/master/arpyino/main.py)

`pip install arpyino`

Arpyino is really tiny but saves your time. It basically reads the serial port of your Arduino board.

# Usage

## Basic Usage

```python

import arpyino

ard = arpyino.Arduino('/dev/ttyACM0', 9600)

while (1 == 1):

  print(ard.readAll())

```

## Configuring components

This is can be useful when you have more than one modules connected to your Arduino board.

```python

import arpyino

ard = arpyino.Arduino('/dev/ttyACM0', 9600)

# the `:servo:` here is the prefix that you will send along with the data from your Arduino

ard.configure('ultrasonic', ':ultrasonic:')

while(1 == 1):

  print(ard.read('ultrasonic'))

```

### Installation

It's quite obvious:

`pip install arpyino`

### License

MIT License

Copyright (c) 2018 Divy Srivastava

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.