sra-board-component

An ESP-IDF Component for SRA Board
Explore the docs »

View Demo · Report Bug · Request Feature · Send a Pull Request

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Examples
• Roadmap
• Contributing
• License
• Contact

About The Project

SRA ESP-IDF component provides an abstraction

Built With

• C

Toolchain & Supported SDK

• ESP-IDF v4.4-release

Docs

• Doxygen

Getting Started

• Hardware Required : SRA Development Board
• Recommended ESP-IDF v4.4-release .

Refer espressif-docs for intallation guide

Prerequisites

• A stable release of ESP-IDF
• Project Tree containing components dir

- myProject/
             - CMakeLists.txt
             - sdkconfig
             - components/ - component1/ 
                           - component2/ 
             - main/       - CMakeLists.txt
                           - src.c
             - build/

Installation

cd <your_esp_idf_project>
mkdir components
cd components
git clone https://github.com/SRA-VJTI/sra-board-component.git

Usage

• Visit examples

For more examples, please refer to the Documentation

Examples

Example Link	Description
Bar Graph	Bar graph led can be used for testing purposes
Light sensing array	LSA aka Light Sensing Array is used mainly in line following bot
Motor driver - normal- parallel	Example for using two motor drivers present on SRA Board in both parallel and normal mode
MPU6050	MPU6050 combines 3-axis Gyroscope, 3-axis Accelerometer and Motion Processor all in small package. This example is for reading values from mpu6050 accelerometer
Servos	Servos are used in the locomotion of bots like Wall-E . This example is for using the servo port on SRA Board to run servos
Switches	Manual Switches provide the traditional comfort to toggle the input variables. This example is for using four user switches present on SRA Board
OLED	Example for initialising the OLED and diplaying the "Hello World" on the screen

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

• Distributed under the MIT License.

Contact

• @SRAVJTI - https://www.sravjti.in/
• SRA-VJTI Website