mirror of
https://github.com/KevinMidboe/fanController.git
synced 2025-12-08 20:28:59 +00:00
Update README.md
This commit is contained in:
22
README.md
22
README.md
@@ -1,16 +1,32 @@
|
||||
# Connected SMART Curtains
|
||||
# Connected SMART Curtains
|
||||
### (API for fanController)
|
||||
|
||||
## the Idea
|
||||
Since I was young I have always been obsessed with motors. Using motors to control crazy mondane things. *Not because it was hard, but because I could.* So to continue that trend I wanted to be able to control me two roller curtains over my bed. I started prototyping with a Arduino and a couple servos and I now have it up and running.
|
||||
> A little caviate. It is working, but only the one curtain can be lifted again, it has no automation and no wireless connectivity. Needs to be done!
|
||||
>A little caviate. It is working, but only the one curtain can be lifted again, it has no automation and no wireless connectivity. Needs to be done!
|
||||
|
||||
I have rewritten the software several times, and just landed on what just worked so I could get back to procrastinating before my exams. You can check the Arduino code out, I will make sure to comment it well.
|
||||
|
||||
## Install
|
||||
First you need to download node, can be found at here.
|
||||
Next clone or fork this project to your computer. To start we first need to add all our node modules
|
||||
```unix
|
||||
$ npm install
|
||||
```
|
||||
Now that we have all our components for our node project we can start the server.
|
||||
```unix
|
||||
$ node server.js
|
||||
```
|
||||
This will print out the IP and port the website can be reached at. Go to a webbrowser and go to the address printed. You may need to allow that port through your firewall if you have it activated.
|
||||
|
||||
If you want the server to launch at login to the following:
|
||||
```unix
|
||||
$ EXPORT="/usr/share/init.d" +x node /home/{user}/curtains
|
||||
```
|
||||
|
||||
|
||||
## Parts list
|
||||
Under is a list of all the parts I have yet used for this projects. Some I have links to, others I have just found laying around or made out of some random junk. If there are any questions about the items please send me a email. [MAIL](https://google.com)
|
||||
|
||||
Part | Part name | Usage | Link
|
||||
---|---|---|---
|
||||
Stepper motor | Motor: 28BYJ-48 Board: ULN2003 | Rotate curtain | [ebay](https://goo.gl/tHQHP3 "ebay.com Stepper Motors")
|
||||
|
||||
Reference in New Issue
Block a user