https://github.com/montoyamoraga/tinytrainable

Arduino Library for building Tiny Trainable Instruments.
https://github.com/montoyamoraga/tinytrainable

arduino arduino-library media-arts physical-computing tinyml

Last synced: 2 months ago
JSON representation

Arduino Library for building Tiny Trainable Instruments.

• Host: GitHub
• URL: https://github.com/montoyamoraga/tinytrainable
• Owner: montoyamoraga
• License: mit
• Created: 2020-12-05T20:32:55.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-05T05:49:15.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T11:55:08.936Z (3 months ago)
• Topics: arduino, arduino-library, media-arts, physical-computing, tinyml
• Language: C
• Homepage:
• Size: 7.05 MB
• Stars: 4
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# TinyTrainable

## About

TinyTrainable is an Arduino library, part of the project Tiny Trainable Instruments [https://github.com/montoyamoraga/tiny-trainable-instruments](https://github.com/montoyamoraga/tiny-trainable-instruments), created by Aarón Montoya-Moraga, a research assistant at MIT Media Lab's Opera of the Future and Future Sketches research groups.

This library is being written between December 2020 and August 2021, with help from undergrad researchers Peter Tone and Maxwell Wang.

## Distribution

This Arduino library is available on this repository [https://github.com/montoyamoraga/TinyTrainable](https://github.com/montoyamoraga/TinyTrainable), and can also be installed on the Arduino IDE.

## Dependencies

The dependencies of this library are specified on the [library.properties](library.properties) file, which include:

* [Adafruit GFX Library](https://github.com/adafruit/Adafruit-GFX-Library): for output with screen.

* [Adafruit SSD1306](https://github.com/adafruit/Adafruit_SSD1306): for output with screen.

* [Adafruit Thermal Printer Library](https://github.com/adafruit/Adafruit-Thermal-Printer-Library): for outputs with Adafruit Thermal Printer.

* [Arduino_APDS9960](https://github.com/arduino-libraries/Arduino_APDS9960): APDS9960 sensor, to read gestures, color, proximity.

* [Arduino_KNN](https://github.com/arduino-libraries/Arduino_KNN): for machine learning with K-Nearest Neighbors algorithm.

* [Arduino_LSM9DS1](https://github.com/arduino-libraries/Arduino_LSM9DS1): LSM9DS1 IMU sensor, to read accelerometer, magnetometer, gyroscope.

* [Servo](https://github.com/arduino-libraries/Servo): output with servo motors.

There is an additional dependency that must be installed manually:

* [Arduino_TensorFlowLite](https://github.com/tensorflow/tflite-micro-arduino-examples): for machine learning with TensorFlow.

## Contents

This repository is distributed in two branches:

* gh-pages: static website documentation generated with Doxygen, deployed at [https://montoyamoraga.github.io/TinyTrainable](https://montoyamoraga.github.io/TinyTrainable).

* main: source code, code examples, and Ardiuino files for distribution.

The contents of the main branch are:

* [assets/](./assets/): additional assets for the library, including machine learning trained models

* [examples/](./examples/): code

* [src/](./src/)

* [.gitignore](./.gitignore)

* [./CODE_OF_CONDUCT.md](././CODE_OF_CONDUCT.md)

* [CONTRIBUTING.md](./CONTRIBUTING.md)

* [Doxyfile](./Doxyfile)

* [keywords.txt](./keywords.txt)

* [library.properties](./library.properties)

* [LICENSE](./LICENSE)

* [README.md](./README.md)

* [README.pdf](./README.pdf)

### Source code

The source code is distributed in the following files and folders:

* TinyTrainable.h and TinyTrainable.cpp: base classes for the library.

* inputs/: base classes for each input.

* outputs/: base classes for each output.

* tensorflow_speech: additional code for speech recognition, authored by the TensorFlow team.

### Examples

The examples are distributed in 4 folders, ordered alphabetically and in terms of complexity:

* check: no input, intended to check the wiring of the instruments.

* color: color input.

* gesture: gesture input.

* speech: speech input.

Each of these folders contains one example for each of the available outputs:

* buzzer

* led

* midi

* printer

* screen

* serial

* servo

There is one additional helper example called get_gesture_data, for capturing gesture data for creating your own gesture database.

## Hardware

This library is intended to be used with the microcontroller Arduino Nano 33 BLE Sense, and the bill of materials available at [https://github.com/montoyamoraga/tiny-trainable-instruments/blob/main/docs/0-bill-of-materials.md](https://github.com/montoyamoraga/tiny-trainable-instruments/blob/main/docs/0-bill-of-materials.md)

## Releases

* [v0.0.1](https://github.com/montoyamoraga/TinyTrainable/releases/tag/v0.0.1): 2020 December 07, placeholder alpha release, for testing the Arduino library ecosystem.

* [v0.1.0](https://github.com/montoyamoraga/TinyTrainable/releases/tag/v0.1.0): 2021 January 12, alpha release with first draft versions of each class, and some examples.

* [v0.2.0](https://github.com/montoyamoraga/TinyTrainable/releases/tag/v0.2.0): 2021 Sunday June 20, beta release for workshops.

## License

MIT