Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dsw7/inodaqv2
A multifunction I/O device built atop the ATmega328P microprocessor
https://github.com/dsw7/inodaqv2
Last synced: 29 days ago
JSON representation
A multifunction I/O device built atop the ATmega328P microprocessor
- Host: GitHub
- URL: https://github.com/dsw7/inodaqv2
- Owner: dsw7
- Created: 2023-01-23T09:05:00.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T10:59:19.000Z (8 months ago)
- Last Synced: 2024-05-11T07:47:32.201Z (8 months ago)
- Language: Python
- Homepage:
- Size: 178 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# InoDAQV2
[](https://github.com/psf/black)
A multifunction I/O device built atop the ATmega328P microprocessor.
## Table of Contents
- [Setup](#setup)
- [Step 1 - Install `arduino-cli`](#step-1---install-arduino-cli)
- [Step 2 - Install package](#step-2---install-package)
- [Step 3 - Upload source](#step-3---upload-source)
- [Step 4 - Start webserver](#step-4---start-webserver)
- [Usage](#usage)
- [Window: Digital](#window-digital)
- [Window: PWM](#window-pwm)
- [Window: AnalogRead](#window-analogread)
- [Window: DigitalRead](#window-digitalread)
## Setup
### Step 1 - Install `arduino-cli`
This project uses [arduino-cli](https://github.com/arduino/arduino-cli) to upload Arduino source code to the
target device. To install `arduino-cli`, follow the
[Quickstart](https://github.com/arduino/arduino-cli#quickstart) section provided by the `arduino-cli`
developers.
**NOTE:** This project was only tested with the Arduino Uno. Other boards may or may not be compatible.
### Step 2 - Install package
To install the `inodaqv2` Python package, run:
```console
make setup
```
The installation process will produce some build artifacts. These artifacts can be cleaned up by running:
```console
make clean
```
### Step 3 - Upload source
To upload the source, run:
```console
./upload
```
Which will prompt:
```console
...
1. Select serial port for upload [default = COM3]:
>
```
Where this port would refer to a valid serial device, such as `COM3` on Windows or `/dev/ttyS2` on
Linux. Hit enter and continue. The install script will then prompt:
```console
...
2. Select Fully Qualified Board Name (FQBN) [default = arduino:avr:uno]:
>
```
Insert a valid FQBN and hit enter.
### Step 4 - Start webserver
As a final sanity check, run the webserver:
```console
inodaq --serial-port=
```
This command will host a site locally using Flask's internal development server. Note that this webserver
should not be used in a production environment. A URL will be printed to the console if a connection to the
serial device is successfully established. Navigate to this URL to use the product.
## Usage
### Window: Digital
This window is used to toggle digital pins 2 through 13 on the device. The pins toggle to either a HIGH or LOW
state. Toggling pin 13 on an Uno device should turn the onboard LED either on or off. This behaviour can be
used as a sanity check.
### Window: PWM
This window can be used to emit a PWM wave on any PWM compatible digital pin. The slider is used to select the
duty cycle of the emitted wave. The PWM output frequency is approximately 490 Hz.
### Window: AnalogRead
This window can be used to read the analog voltages on analog pins A0 through A5.
### Window: DigitalRead
This window can be used to read the binary states of analog pins A0 through A5.