mirror of
https://github.com/rodneyosodo/automating-home-lights.git
synced 2026-06-23 04:10:15 +00:00
Adding readme
This commit is contained in:
@@ -6,6 +6,89 @@ A demonstration of using nodemcu connected to a solid state relay to switch on a
|
||||
[](https://www.codefactor.io/repository/github/0x6f736f646f/automating-home-lights)
|
||||
[](https://travis-ci.com/0x6f736f646f/automating-home-lights)
|
||||
[](https://coveralls.io/github/0x6f736f646f/automating-home-lights?branch=master)
|
||||
|
||||
## Prerequistes
|
||||
|
||||
#### Software
|
||||
* Docker
|
||||
* Ngrok
|
||||
* LocalXpose
|
||||
* Make
|
||||
* Python3
|
||||
* Putty
|
||||
* esptool
|
||||
* ampy
|
||||
|
||||
#### Hardware
|
||||
* Nodemcu
|
||||
* Jumper wires
|
||||
* Solid state relay
|
||||
* Extension cable
|
||||
* Lamp
|
||||
|
||||
## Getting started
|
||||
To get this project up and running on your machine, follow the following instructions.
|
||||
|
||||
#### Dialogflow
|
||||
Check out the documentation to get yourself up and running with the dialogflow agent
|
||||
|
||||
#### Hardware
|
||||
Check out the documentation to setup the hardware
|
||||
|
||||
#### Programming
|
||||
This instructions will be different for windows users.
|
||||
|
||||
```shell
|
||||
mkdir projectHomeAutomation
|
||||
cd projectHomeAutomation
|
||||
virtualenv --no-site-packages --python=python3 venv
|
||||
source venv/bin/activate
|
||||
git clone https://github.com/0x6f736f646f/automating-home-lights
|
||||
cd automating-home-lights
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
#### Getting started with micropython
|
||||
|
||||
|
||||
#### Getting started with dialogflow
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
Reference in New Issue
Block a user