Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tirtharajsinha/iot-and-robotics
IOT and Robotics introductory guide with some projects
https://github.com/tirtharajsinha/iot-and-robotics
arduino arduino-boards arduino-library circuitpython esp-idf esp32 esp8266 iot micropython processing robotics
Last synced: 5 days ago
JSON representation
IOT and Robotics introductory guide with some projects
- Host: GitHub
- URL: https://github.com/tirtharajsinha/iot-and-robotics
- Owner: tirtharajsinha
- License: gpl-3.0
- Created: 2021-03-18T16:00:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-09T15:47:48.000Z (about 1 year ago)
- Last Synced: 2023-11-09T16:43:08.549Z (about 1 year ago)
- Topics: arduino, arduino-boards, arduino-library, circuitpython, esp-idf, esp32, esp8266, iot, micropython, processing, robotics
- Language: C
- Homepage: https://tirtharajsinha.github.io/IOT-and-Robotics/
- Size: 88.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IoT & Robotics projects with Codes + Circuit Digram
## Popular Types of Microcontroller Series and examples
| Name | Example |
| ----------------------- | -------------------------------- |
| AVRSeries | Atmega328p, Atmega2560 |
| RENESAS Microcontroller | RA4M1 |
| Espressif Chips | ESP8266, ESP32, ESP32S3, ESP32C6 |
| RP2040 | RPi Pico |
| STM Microcontroller | STM32F4011CCU, STM8S103F3 |
| INTEL Microcontroller | Intel 8051 |
| NXP | NXP iMXRT1062 |
| NRf | nRF52832 |
| PIC Family | PIC16F877A |
## Popular Development Boards and SBC
| Name | Processor name | Tested |
| ---------------------- | ----------------------- | ------ |
| Arduino UNO R2 Wifi | ATmega4809 + NINA-W102 | No |
| Arduino UNO R3 | Atmega328p | Yes |
| Arduino UNO R4 Minima | RA4M1 | No |
| Arduino UNO R4 Wifi | RA4M1 + ESP32S3(WiFi) | No |
| Arduino Nano Every | Atmega328p(SMD version) | Yes |
| Arduino Nano ESP32 | NORA-W106 (ESP32-S3) | No |
| Arduino Mega 2650 | Atmega2560 | No |
| Arduino Giga R1 Wifi | STM32H747XI | No |
| Nodemcu ESP8266 Devkit | ESP8266EX | Yes |
| DoIt esp32 devkit-V1 | ESP-Wroom-32 | Yes |
| ESP32-CAM | ESP-Wroom-32 | Yes |
| ESP32 C3 DevkitC-1 | ESP32-C3-N4R2 | No |
| ESP32 S2 DevkitC-1 | ESP32-S2-Solo-N4 | Yes |
| ESP32 S3 DevkitC-1 | ESP32-S3-N8R8 | Yes |
| ESP32-S3-Pico | ESP32-S3-R2 | Yes |
| ESP32 C6 DevkitC-1 | ESP32-S6-N8R8 | No |
| Raspberry Pi Pico | RP2040 | Yes |
| Raspberry Pi Pico W | RP2040 + CYW43439(wifi) | No |
| Raspberry Pi 4B | Broadcom BCM2711 | Yes |
| Raspberry Pi 5 | Broadcom BCM2712 | No |
| Blackpil STM32 | STM32F401CCU6 | No |
### Minimal Component Requirements
- One of the above board(Atleast : Arduino UNO R3)
- _USB type A_ to _USB type B_ Connector Vable
- _USB type A_ to _Micro USB_ Connector Cable
- led(Red,green,blue,RGB)
- jumpers(MtoM and MtoF)
- breadboard
- Register(220ohm,1Kohm,10Kohm)
- capacitor(220 microfarad,47 microfarad)
- Some sensors(DHT11, HC-SR04)
### Components (Required : based on project)
#### Sensors and Modules
- HC-SR04 Ultrasonic distance sensor\*
- DHT11 temparature and humidity sensor\*
- BISS0001 PIR Motion sensor
- MPU-6050 3-Axis Accelerometer and Gyro Sensor
- _TTP223B_ Capacitive Touch Sensor Module
- LM393 Sound Detection Module
- IR receiver + Remote
- DS3231 RTC Module
- MS5611 Barometer, Temperature & Altimeter Sensor
- BME280-3.3V(I2C & SPI) Barometer, Temperature, Humidity & Altimeter Sensor
- BME280-5V(I2C) Barometer, Temperature, Humidity & Altimeter Sensor (Recommended)
- BME680 Barometer, Temperature, Humidity, Altimeter & Gas Sensor
#### Camara Module
- ov2640 camera module.
- ov7670 camera module.
- Arducam ov7670 SPI camara module.
#### Wireless/Communication Modules
- ESP-01 ESP8266 Serial WIFI Module
- HC-05 Bluetooth Module
- Ublox Neo-6M GPS Receiver Module
#### Displays and LED MOdule
- 16x2 LCD Display
- Single digit _7 segment_ display
- 0.96inch OLED I2C display
- Color LCD SPI Display
- WS2812 RGB LED MATRIX/RING
- MAX7219 LED Dot Matrix Display
- I2C 8x16 RGB LED Matrix Panel
#### Motors
- 12V 200 RPM DC Motor
- 28BYJ-48 Unipolar Stepper Motor
- SG90 Servo Motor (180° Rotation)
#### Motor Drivers and Shields
- L293D IC
- L293D Motor Driver Shield(Arduino UNO/Mega)
- L293D Motor Driver Board for ESP8266 NodeMcu 12E
- L298N motor driver module
- ULN2003 Stepper Motor Driver
- A4988 driver Stepper Motor Driver
#### Others
- 2N2222 transistor
- 2/4 - channel 5V relay module
## Softwere requirements
- [Arduino IDE(Latest version)](https://www.arduino.cc/en/software)
- [Arduino IDE(v1.8.3 if you have arduino nano)](https://downloads.arduino.cc/arduino-1.8.3-windows.exe)
- [Thonny(If micropython/circuitpython is used)](https://thonny.org/)
- [Platform IO](https://platformio.org/)
- [ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/)
## How to get started
#### Installation of IDEs and Clone repo.
**_Install the Arduino IDE & Clone this repository_**
```
git clone https://github.com/tirtharajsinha/IOT-and-Robotics.git
```
1. Connect the arduino board via USB.
2. Open the arduino IDE
3. select the board and port number(something like `COM5`)
4. Now open `LED_BLINK/LED_BLINK.ino` in arduino ide.
5. Connect the circuit diagram available the .ino code location.
6. Open the arduino ide and validate and upload the script.
7. If you see led lights up and down periodically then you are good to go. othewise contact a experienced friend. if you friend refuses then your are fucked up, go search on youtube.
#### Upstream the repository
```
git reset --hard origin/main
git remote add upstream https://github.com/tirtharajsinha/IOT-and-Robotics.git
git fetch upstream
git checkout main
git merge upstream/main
```
If anytime you think you messed up with the original repo code then you can consider reset the rerository.
#### Reset repository
```
git reset --hard origin/main
```
## Arduino libraries you need to get started
1. Adafruit Circuit Playground by Adafruit\*
2. Servo by Michael Margolis, Arduino
3. DHT sersor library by Adafruit\*
4. Adafruit Unified sensor by Adafruit\*
5. Firmata by firmata developers
6. WiFi by Arduino
7. LiquidCrystal by Arduino, Adafruit
8. Arduino_JSON by Arduino
## Diffrent type arduino boards
#### Classic family
1. Arduino UNO R3
2. Arduino Mega 2560 Rev3
3. Arduino Leonardo
4. Arduino UNO Mini Limited Edition
5. Arduino Due
6. Arduino Micro
7. Arduino Zero
8. Arduino UNO WiFi Rev2
#### Nano family
1. Arduino Nano 33 IoT
2. Arduino Nano RP2040 Connect
3. Arduino Nano 33 BLE Sense
4. Arduino Nano 33 BLE
5. Arduino Nano Every
6. Arduino Nano
#### MKR family
1. Arduino MKR 1000 WiFi
2. Arduino MKR WiFi 1010
3. Arduino MKR FOX 1200
4. Arduino MKR WAN 1300
5. Arduino MKR WAN 1310
6. Arduino MKR GSM 1400
7. Arduino MKR NB 1500
8. Arduino MKR Vidor 4000
9. Arduino MKR Zero
#### Portena family(Arduino Pro)
1. Portena H7
2. Portena X8
3. Portena Max Carrier(Carrier for portena)
## ESP based boards
As ESP based borads are also available from third-party manufactures like adafruit,unexpectedmaker,wemos,waveshare etc. so listing all boards is almost impossible. This [Page](https://www.espressif.com/en/products/modules) lists all esp official espressif products.
#### Here we are only listing the popular ESP32 SOC series.
1. ESP8266
2. ESP32
3. ESP32 H2
4. ESP32 C3
5. ESP32 C6
6. ESP32 S2
7. ESP32 S3
### Development Environment and Languages for ESP boards
> ESP32 supports multiple development Environment and Languages
- Arduino IDE (C++)
- ESP-IDF (C and C++)
- PlatformIO (C)
- Thonny (MicroPython,CircuitPython)
- nanoFramework(C#)
### Raspberry Pi 2040 Based Boards
1. Raspberry Pi Pico /W.
2. Adafruit Feather RP2040.
3. Arduino Nano 2040 Connect.
4. Cytron Maker Pi Pico.
5. Adafruit QT Py RP2040.
6. Seeed XIAO RP2040.
7. Pimoroni Tufty 2040.
8. Pimoroni Keybow 2040.
9. Sparkfun Pro Micro.
10. ... etc.
### Development Environment and Languages for RP2040 based bords
> RP2040 based board supports multiple development Environment and Languages
- Arduino IDE (C++)
- PlatformIO (C)
- MicroPython,CircuitPython
- RPi C/C++ SDK
# Setup of Development Environmnts
## Arduino IDE Setup for Boards
### Arduino boards
These board has arduino IDE Support by default.
- Start Arduino IDE
- Plug your board
- Select your board(like: Arduino Uno R3, Arduino Mega, Arduino Nano etc.)
- Select Port (like COM3[for windows], dev/tty0[for linux/OS X] etc.)
- Write Code > Compile code (Tick icon) > Upload Code to board (Upper arrow icon)
### ESP Boards
- Start Arduino and open Preferences window.
- for your specific boards use below url to install boards manager
```
ESP8266
https://arduino.esp8266.com/stable/package_esp8266com_index.json
ESP32/ESP32 H/S/C
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
```
Put these url into Additional Board Manager URLs field. You can add multiple URLs, separating them with commas.
- Open Boards Manager from Tools > Board menu and find esp8266/esp32 platform.
- Select the version you need from a drop-down box.
- Click install button.
- Don’t forget to select your esp board from Tools > Board menu after installation.
#### Upload program to esp boards
- for **Esp32/esp8266/C3**
- after initiate upload press and hold the `BOOT` button after upload done unpress boot button
- For **Esp32 S2/S3/C6 [ Boards with 1 usb port on board ]**
- after initiate upload press and hold the `BOOT` button after upload done unpress boot button
- For **Esp32 S2/S3/C6 [ Boards with 2 usb port on board ]**
- #### First Way - Connect board to USB to UART bridge (usb port with UART label) [Recommended WAY]
Before upload Go to `TOOLS` then `USB CDC on BOOT > Disable`, `update the UPLOAD MODE > UART`. Now hit Upload.
- #### Second Way - Connect board to USB (usb port with USB label)
Before upload Go to `TOOLS` then `USB CDC on BOOT > Enable`, `update the UPLOAD MODE > Intarnal USB`. Now hit Upload.
> For First time if it does not get recognised by windows(Which you can check by device manager) press and hold **_BOOT_** button and click **_RESET_** button now unpress the **_BOOT_** button. Now follow the above steps.
#### Additional/Importent Arduino Libraries for esp8266/esp32
1. esp8266 by ESP8266 Community
2. ESP32 by Espressif Systems
3. [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
4. [ESPAsyncTCP for esp8266](https://github.com/me-no-dev/ESPAsyncTCP)
5. [AsyncTCP for esp32](https://github.com/me-no-dev/AsyncTCP)
### Raspberry Pi Pico /W
Follow [this tutorial](https://www.tomshardware.com/how-to/program-raspberry-pi-pico-with-arduino-ide) to set up arduino ide with RPi Pico boards.
[Arduino Core](https://github.com/earlephilhower/arduino-pico) for RP2040 based boards.
## Micropython(Some selected boards are supported) setup
#### Common boards that supported by micropython
1. all esp based boards.
2. Arduino nano RP2040 connect and Arduino Nano 33 BLE Sense
3. Arduino pro portena H7
4. all pyboards
5. Raspberry Pi pico & Pico W
6. BBC micro:bit v1
7. Adafruit Feather series
### Micropython libraries:
Find needed packages from [awesome-micropython.com](https://awesome-micropython.com/)
Follow [This Guide](https://docs.micropython.org/en/latest/reference/packages.html) to install a micropython package.
### IDE Installation
- Now you need a IDE. I prefer **_thonny_** for this as it has REPL terminal For Installation guide follow this [blog form Adafruit](https://learn.adafruit.com/circuitpython-libraries-on-micropython-using-the-raspberry-pi-pico/thonny-setup).
### Firmware Installation to target board
First read micropython [docs](https://micropython.org/download/) to check if your micropython support your board. If your board is supported you can go ahead.
- [Easy method] Connect board to computer via USB > Open thonny > tools > options > interpreter > select Micropython > install or update Micropython.
- [Other Method] Download the micropython firmware file :
1. [esp32](https://micropython.org/download/esp32/)
2. [esp8266](https://micropython.org/download/esp8266/)
3. For others you can find [here](https://micropython.org/download/)
- Install the flash tool for esp boards :
```
pip install esptool
```
or
```
pip3 install esptool
```
verify installation with `esptool --help` command.
- Connect the esp board wit your computer and get the port number. It should be like `COM5 or /dev/ttyUSB0`
- Now open cmd where you downloaded the firmware/bin file.
- Run the following commands :
**Notice** : After entering the command before pressing `Enter` press the boot button in your esp board and press enter in your keyboard don't unpress until command executes.
**Erase previous firmware**
```
esptool --port erase_flash
```
**Install micropython firmware**
```
esptool --port --baud 460800 write_flash --flash_size=detect 0
```
#### Clear Flash
To remove and get back to Arduino IDE, Run the following command :
```
esptool.py --port erase_flash
```
### Use circuitpython libraries through micropython
First find your device is supported or not [here](https://circuitpython.org/blinka)
Read installation docs [Docs from adafruit](https://cdn-learn.adafruit.com/downloads/pdf/circuitpython-libraries-on-micropython-using-the-raspberry-pi-pico.pdf)
## CircuitPython(Some selected boards are supported)
- Find the [CircuitPython Docs](https://docs.circuitpython.org/en/latest/README.html)
- First search you board [here](https://circuitpython.org/downloads) to check if your board is supported by CircuitPython.
- [Note] : if your board not supported you can build your board by yourself. [Find docs here](https://learn.adafruit.com/building-circuitpython/build-circuitpython).
### Firmware Installation
In this case every board have diffrent method to install circuitpython. follow boards specific method in adafruit site.
- Download the circuitpython _BOOTLOADER ZIP_ and .uf2 file [here.](https://circuitpython.org/downloads)
- `[Recommended Method]` follow the Install, Repair, or Update UF2 Bootloader instruction in Adafruit site.
- `[Other Method/esp boards]` Download the firmware(.zip) file > unzip it > flash `combine.zip` with the help of esptool.
- ESP32 S/C/H : For reference Follow this [Youtube Video](https://www.youtube.com/watch?v=RYkwgs5rXBM).
- Raspberry Pi Pico with [CircuitPython](https://learn.adafruit.com/getting-started-with-raspberry-pi-pico-circuitpython/circuitpython)
#### Flash Resetting UF2
If your Pico ever gets into a really weird state and doesn't even show up as a disk drive when installing CircuitPython, try installing this [flash_nuke.uf2](https://cdn-learn.adafruit.com/assets/assets/000/099/419/original/flash_nuke.uf2?1613329170) which will do a 'deep clean' on your Flash Memory. You will lose all the files on the board, but at least you'll be able to revive it! After nuking, re-install CircuitPython.
### Circuitpython libraries and frameworks
CircuitPython libraries are written in Python. They provide additional functionality and support external devices, beyond what is in CircuitPython itself.After connect your board to your computers usb you should see a drive named _CIRCUITPY_. Libraries are stored on your CIRCUITPY drive in a folder called lib.
#### Automatic Installation using CircUp
1. Install python 3.5 or later in your laptop or desktop.
2. Open Terminal and create a virtiual environment with
```
pip install virtualenv
virtualenv venv
./venv/Scripts/activate
```
3. Open Terminal and run
```
pip install circup
```
4. Connect your board.
5. run `circup --help` to know all the command.
6. To know more visit [Official Docs](https://github.com/adafruit/circup).
7. Save installed package in `requirements.txt`
```
circup freeze -r
```
#### Manual Installation
1. You can get the circuitpython essential bundle and The Community Bundle [from here.](https://circuitpython.org/libraries)
2. Extract the bundle.
3. Go to `/lib` and copy the required packages(ie. neopixel.mpy)
4. Connect the circuitpython device with your computer. You should see a new drive named `CIRCUITPY`.
5. Paste the copied packages inside `/lib` directory of `CIRCUITPY` drive.
6. You can also get [Indevidual packages from here](https://learn.adafruit.com/circuitpython-essentials/circuitpython-libraries)
### IDE/Text Editor Installation
- Now you need a IDE. I prefer **_thonny_** for this as it has REPL terminal For Installation guide follow this [blog form Adafruit](https://learn.adafruit.com/circuitpython-libraries-on-micropython-using-the-raspberry-pi-pico/thonny-setup).
- For just minor editing you can use **_VS Code_**.
## ESP-IDF
Follow this official instruction for installing [ESP-IDF](https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md) in VS Code.
Follow this [Youtube tutorial](https://www.youtube.com/watch?v=XDDcS7HQNlI) for more precise instruction.
## PlatformIO
[Get started](https://docs.platformio.org/en/latest/tutorials/index.html) with PlatformIO.
Follow This [Youtube Video](https://www.youtube.com/watch?v=JmvMvIphMnY) to learn about installation and Usage.
## Specific Drivers
### CH340 Driver
> These are installation guide, there you can find the driver downloader link.
- Windows [Driver](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all)
- Linux [Driver](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all)
- MAC [Driver](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all)
### CH343 Driver
- Window VCP [driver](https://files.waveshare.com/upload/f/f1/CH343SER.7z)
- Linux [Driver](https://github.com/WCHSoftGroup/ch343ser_linux)
- Android [APP](https://files.waveshare.com/upload/2/22/WCHUARTDemo_V1.3.7z)
- MAC [driver](https://files.waveshare.com/upload/0/04/CH34XSER_MAC.7z)
### FTDI VCP Drivers
- Windows/Linux/Mac [Drivers](https://ftdichip.com/drivers/vcp-drivers/)
## Misc. Docs
| Topic | Description |
| ---------------------------- | ------------------------------------------------ |
| I2C Device address list | https://i2cdevices.org/addresses |
| Linux Hardware Driver Finder | https://linux-hardware.org/index.php?view=search |
-- By Tirtharaj Sinha