ondo-hardware

Hardware implementation of ondo
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Hardwares
   • Prerequisites
     • Environment
     • Set up .env
   • Installation
3. Roadmap
4. Contributing
5. Contact

About The Project

Built With

(back to top)

Getting Started

Hardwares

• Raspberry Pi 4
• DHT-22 Temperature and Humidity Sensor
• HC-SR501 PIR Motion Sensor
• Buttons
• LEDs

Prerequisites

Environment

• Install poetry

Set up .env

• Create a new file named .env at the root of the project.

• Set up the .env file and set the key and values like below.

  SERVER_URL="https://ondo-backend-test.onrender.com"

Installation

1. Clone the repo

   git clone https://github.com/team-ondo/hardware.git

2. Install libraries

   poetry install

3. Run state machine program

   make run-state

4. Run socket client program

   make run-socket

(back to top)

Roadmap

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Contact

Project Link: https://github.com/team-ondo/hardware

(back to top)