From 4a0cf4bcd2a6b5b445e0e3991ab5fb51433f7fd9 Mon Sep 17 00:00:00 2001 From: Duoslow <16846504+Duoslow@users.noreply.github.com> Date: Mon, 15 May 2023 21:16:23 +0300 Subject: [PATCH] readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index e69de29..bbe782e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,28 @@ +### Arduino Uno Spotify Playing Song Display +This project is a simple Arduino Uno project that displays the currently playing song on a Spotify account. It uses the Spotify API to get the currently playing song and displays it on a 16x2 i2c LCD screen. + +## Getting Started +### Prerequisites +* Arduino Uno +* 16x2 i2c LCD Screen +* Spotify API Client ID and Client Secret + +### Installing On Arduino +1. Clone the repository +2. Open the Arduino IDE +3. Install the LiquidCrystal_I2C library +5. Open the `main.ino` file +7. Upload the code to your Arduino Uno + +### Setting Up Spotify API +1. Go to the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard/applications) +2. Create a new application +3. Copy the Client ID and Client Secret +4. Paste the Client ID and Client Secret into the `config.json` file +5. Run the code + +## Built With +* [LiquidCrystal_I2C](https://github.com/fdebrabander/Arduino-LiquidCrystal-I2C-library) - The library used to control the LCD screen (it is also available in the Arduino IDE library manager) +* [Spotify API](https://developer.spotify.com/documentation/web-api) - The API used to get the currently playing song + +## Example Video