arduino-tablature

Node.js project that makes a web scraping to get some guitar tablature and transform it to an Arduino Program compatible with the tone() Function.

About the project

What is a tablature?

Tablature (or tabulature, or tab for short) is a form of musical notation indicating instrument fingering rather than musical pitches. - Wikipedia words

And it looks like this:

Nice, but what can i do with this project?

So, with a circuit like that:

Using this project you can play your favorite songs in your own Arduino.

How to use it (Recommended way)

First of all, make sure you have npm and node installed.

Installation

Open your terminal and type:

sudo npm install -g arduino-tablature

Now you have the arduino-tablature command available globally

Picking your tablature

• Go to CifraClub's WebSite and search for your song, which has a tablature on it.

Example:

https://www.cifraclub.com.br/natiruts/andei-so/

Running the code

Then execute in the terminal, with your url in the url param:

arduino-tablature --url=https://www.cifraclub.com.br/natiruts/andei-so/

Uploading to Arduino

After that a music.ino file will be generated, inside the music folder, and you will be able to upload it to your arduino using the Arduino IDE or others.

Alternative way

Installation

1. start cloning/downloading this repository. if you download a .zip or .tar.gz file, unzip the file.
2. In the terminal navigate to the folder, then run:

npm install

After it all the dependencies packages are all set.

Picking your tablature

• Go to CifraClub's WebSite and search for your song, which has a tablature on it.

Example:

https://www.cifraclub.com.br/natiruts/andei-so/

Running the code

Then execute in the terminal, with your url in the url param:

node index.js --url=https://www.cifraclub.com.br/natiruts/andei-so/

Uploading to Arduino

After that a music.ino file will be generated, inside the music folder, and you will be able to upload it to your arduino using the Arduino IDE or others.

Broken Musics and Bugs

Some music is not working? We have a thread issue open to report bugs in specific musics, report in the issue following the report example, and soon as possible the community will fix it.

Some bug? You can also open your own issue to report a bug.

tip: It is a good idea, when you find a bug, open a issue to report it, and make a pull request with the solution, becoming a contributor of the project

Contributors

Thiago Augusto (GitHub :octocat:) Idealization and coding

Otacilio Maia (GitHub :octocat:) Documentation and coding

Yourself

Become a contributor, fork this repository, make your modifications and submit a pull request. See the complete list of contributors.

License

See the LICENSE file for license rights and limitations (MIT).