Skip to content

Update README.md #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jaidenfe wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 5 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,15 @@

This project aims to create a low cost home automation illumination device that will turn any lamp or light source into a smart light source. Instead of replacing the light blub or wall socket, we aim to replace the light socket itself, allowing the user to conintue using the light blubs they already have for their homes.

<h3>Compiling</h3>
<h3>Getting Started</h3>

The project is currently compiled by running the makefile in the tests/server folder.
The project has two devices: the Lux Hub and the Lux SmartSocket.

make server_test
The Lux Hub is run on a raspberry pi. To set up the Lux Hub download the hub_setup script in the top-most directory. Move this to the raspberry pi. Make sure the raspberry pi has internet access and run the script by typing './hub_setup'. You may have to run this as root. The Lux Hub is now setup and has the most up to date software from this Lux repository.

<h3>Execution</h3>
The Lux Hub will now automatically run the Hub software when it is powered up. The user must plug the raspberry pi into their router and power the raspberry pi on for the system to work. The user can now access the Hub Dashboard by visiting 192.168.1.XXX, where XXX is a number from 2 - 254. We are looking into ways to set a domain name instead of an IP address without requiring the user to modify their current network setup.

To execute the program:

*plug the Lux device into a light bulb socket and plug a light bulb into the female socket

*start the Lux device and connect to the ESP_XXXX website via localhost:8080

*provide the website with the IP address of your WiFi network

*start/connect a controller device (PC/Phone) to your WiFi

*compile and run the server_test.exe in the tests/server folder as instructed above

*push the RED button on the Lux device

*connect to the website at localhost:5000

*sign in on the website with username 'admin@admin.com' and password 'admin'

*hit the submit button to turn the light on, sign in and hit it again to turn the light off
The Lux SmartSocket is a custom peice of hardware with custom firmware (located in 'Lux/src/firmware/ESP8266_LUX_FIRMWARE_V1/'). If you are interested in aquiring a device please reach out to our development team.

<h3>Contributor</h3>
Xuanyu Dong (Front End)