Skip to content

Commit

Permalink
first public commit
Browse files Browse the repository at this point in the history
  • Loading branch information
genemars committed Jan 27, 2019
1 parent 95dc95d commit bcae058
Show file tree
Hide file tree
Showing 13 changed files with 54,028 additions and 126 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
.piolibdeps
.clang_complete
.gcc-flags.json
.idea
168 changes: 42 additions & 126 deletions .idea/workspace.xml

Large diffs are not rendered by default.

79 changes: 79 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# HomeGenie Mini

HomeGenie mini is an open source hardware + firmware solution for building smart devices
based on the popular *ESP8266 chip*, a WiFi capable micro controller.
This project can can be employed for a variety of Home Automation and IoT applications.

**Hardware features**

- Quick install via WPS button and automatic discovery (SSDP)
- Temperature and light sensing
- RF transceiver (315/330/433Mhz) currently implementing **X10** home automation protocol
- Expansion port with SPI and up to 5 GPIO/PWM

**Software features**

- Scripting engine (\*)
- HTTP API (subset of standard HomeGenie API)
- Real time event stream over WebSocket or SSE connection
- MQTT broker over websocket
- SSDP
- NTP client for time sync

<small>**(*)** *currently work in progress*</small>

**Mobile client**

- HomeGenie plus for Android

The expansion port can be used for various applications such as:

- control a led brightness or drive a motor at different speed
- control up to 5 relays to actuate lights and appliances
- hosting other sensors
- interfacing with other hardware
- breadboard playground

## Building HomeGene Mini

![HomeGenie mini PCB front and rear](https://raw.githubusercontent.com/genielabs/homegenie-mini/master/pcb/homegenie_mini_v1_1_pcb.png)

### Hardware

Required Gerber files for printing the printed circuit board are located in the `./pcb` folder.

- https://github.com/genielabs/homegenie-mini/tree/master/pcb

**Components listing**

- ESP8266 WeMoo D1 mini WiFi module (or equivalent)
- 1 DS18B20 (temperature sensor)
- 1 LDR (light sensor)
- 1 FS1000A (RF transmitter)
- 1 XY-MK-5V (RF receiver)
- 1 R1 10kΩ
- 1 R2 4.7kΩ
- 1 R3 330Ω
- 1 R4 330Ω
- 2 LED 3mm
- 1 push button 6mm*6mm

### Firmware

The firmware source code is built using *Platform.IO* and based on *Espressif*
platform and *Arduino* framework.

**Source code**

- https://github.com/genielabs/homegenie-mini/tree/master/src

**Release**

- https://github.com/genielabs/homegenie-mini/releases/


## Disclaimer

<small><pre>
THIS PROJECT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS PROJECT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre></small>
26 changes: 26 additions & 0 deletions pcb/HomeGenie_Mini_V1.1.25_contour.gm1
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
G04 MADE WITH FRITZING*
G04 WWW.FRITZING.ORG*
G04 DOUBLE SIDED*
G04 HOLES PLATED*
G04 CONTOUR ON CENTER OF CONTOUR VECTOR*
%ASAXBY*%
%FSLAX23Y23*%
%MOIN*%
%OFA0B0*%
%SFA1.0B1.0*%
%ADD10R,1.732280X1.968500*%
%ADD11C,0.008000*%
%ADD10C,0.008*%
%LNCONTOUR*%
G90*
G70*
G54D10*
G54D11*
X4Y1965D02*
X1728Y1965D01*
X1728Y4D01*
X4Y4D01*
X4Y1965D01*
D02*
G04 End of contour*
M02*
Loading

0 comments on commit bcae058

Please sign in to comment.