forked from genielabs/HomeGenie
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.TXT
248 lines (177 loc) · 7 KB
/
README.TXT
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
LICENCE
Please read the LICENCE.TXT file.
DISCLAIMER
==========
THIS SOFTWARE 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 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
HOMEPAGE, DOCUMENTATION AND FORUM
=================================
http://www.homegenie.it
http://www.homegenie.it/docs
http://www.homegenie.it/forum
AUDIENCE
========
This project is mainly addressed to developers and tech enthusiasts, with the aim of becoming more and more friendly for everyone's use.
If you like this project and want to contribute, you can do this in many ways: sending feedback; reporting bugs; fixing bugs; improving/adding features; beta testing; suggesting new features; donating.
MISSION
=======
- Developing an easy to use and generic purpose Home Automation Server that will have highly extensible/programmable features
- Giving a concrete common language "chance" to all "connected" devices and standards, humans included =)
- Building a "Do It Yourself" HG server box, based on Raspberry Pi, with integrated display and also supporting direct plugging of HW add-ins (1-wire sensors and other easy to plug devices)
- Making HomeGenie boxes "talk" each other and interoperate
Some of these goals have been already accomplished (see CURRENT FEATURES).
Other expected features:
- Support for other multimedia wireless standards (eg. Bluetooth, AirPlay)
- Generic I/O Device Wireless Router and Framework (see MIG)
CURRENT FEATURES
================
* Modern, web based, responsive UI
use it on every device, from desktop PCs to smart phones and tablets
* Integrated drivers for X10 and Z-Wave devices
ready to use solution for your home automation
* Real and virtual energy metering with statistics
energy consumption awareness for optimizing costs and usage
* UPnP / DLNA control point
control media receiver, renderer and light/switch device types
* Wizard Scripting
no need to be a programmer, create scenarios with your fingers using the "live macro recording" feature
* Automation Program Plugins (APPs)
easily add/share new automation programs and features
* Localization
English, Italian, Spanish, French, Netherlands. Other languages can by added by creating a simple JSON file.
* Password protected access
* Configuration backup/restore and factory reset
* Embeddable
runs on low-energy and low-cost embedded systems such as Raspberry Pi
* Customizable widgets and features
create new features and widgets that interact with your devices and internet services
* Programmable Automation Engine
web based Program Editor and compiler with multi-language support: C#, Javascript, Phyton and Ruby, Arduino Sketch
* Dynamic Web Service API and Helper Classes
make your devices and services talk each other using a common language over the net
* Direct access to Raspberry Pi hardware
GPIO, SPI, I2C programming using an event driven model
* Virtual modules
* Speech recognition / Voice Control (using Web Speech API)
* Speech synthesys (cloud based)
* Programmable InfraRed transceiver
use a common IR remote to control your automation system
* Video4Linux camera video driver
use a webcam as a remote monitoring device
* Mobile app clients (Android, Windows Phone)
* Open Source
BUILT-IN INTERFACES AND PROTOCOL DRIVERS
========================================
- X10 Marmitek CM15Pro USB interface
- X10 Marmitek CM11/CM12 Serial interface
- X10 W800RF32AE X10 RF receiver
- Z-Wave Aeon Labs Z-Stick 2 and other Zensys API compatible controllers
- Z-Wave RaZberry, Z-Wave daughter board for Raspberry Pi
- Insteon Insteon PLM 2413S/2413U
- LIRC Any LIRC compatible IR transceiver
- GPIO Raspberry Pi GPIO 1Wire/SPI/I2C
- Arduino Integrated Arduino(TM) development
- V4L Video4Linux camera video driver
- Serial Generic serial port interface
- TCP Generic TCP interface
- UDP Generic UDP interface
BUILT-IN X10 FEATURES
=====================
- PLC: All Light On, All Units Off, On, Off, Dim, Bright
- RF: raw data receive and decoding
BUILT-IN Z-WAVE FEATURES
========================
- Nodes Discovery
- Node Inclusion/Exclusion
- Manufacturer Specific Get and Node Information (NIF)
- Basic Get/Set/Report
- Wake Up Get/Set
- Association Get/Set/Remove
- Association Group Get/Set/Remove
- Configuration Variable Get/Set
- MultiInstance/Channel Get/Set/Report (SwitchBinary, SwitchMultiLevel, SensorBinary, SensorMultiLevel)
- Metering Report
- Thermostat Mode/OperatingState/SetPoint/FanMode/FanState/Heating/SetBack
- UserCode
BUILT-IN Z-WAVE MODULE TYPES
============================
- Switch
- Dimmer Light (MultiLevel Switch)
- Siren
- MultiChannel Switch / Dimmer
- Motion Sensor
- Temperature Sensor
- Luminance Sensor
- Door/Window Sensor
- Flood Sensor
- Smoke Sensor
- Heat Sensor
- CarbonDioxide Sensor
- CarbonMonoxide Sensor
- Thermostat
AUTOMATION PROGRAM PLUGINS (APPs)
=================================
Lights
- Level Memory
- Smart Ligths
Energy Management
- Energy Monitor
- Energy Saving Mode
- Turn Off Delay
Scenes
- Group Lights ON/OFF
- Sunrise Color Scenario
Weather and Enviroment
- Earth Tools
- Generic Thermostat
- jkUtils OpenWeatherData
- jkUtils Solar Altitude
- Weather Undergroud
Messaging and Social
- Alcatel One Touch Y800Z SMS Notify
- E-Mail Account
- Pushing Box
- Windows Phone Push Notification Service
Devices and Things
- Favourites Links
- Generic IP Camera
- One-Wire Devices
- Philips Hue Bridge
- Serial Port I/O example
X10
- SC9000 RF Virtual Modules
- Set to 100% when switched on
- X10 RF Virtual Modules Mapper
Z-Wave
- Fibaro RGBW
- RFID Tag Reader
- Level Poll
- Multi Instance/Channel Virtual Modules
- Query on Wake Up
Security
- Ping Me at Home
- Presence Simulator
- Security Alarm System
Interconnections
- IR/RF remote control events forwarding
- Meter.Watts events forwarding
- Sensor.* events forwarding
- Status.Level events forwarding
- MQTT Network
Scheduling
- Timetable (for scheduling lights, shutters, thermostats, appliances)
- Scheduled ON/OFF
Raspberry Pi
- DHT-11 Temperature/Humidity sensor
- DHT-22 Temperature/Humidity sensor
- GPIO Modules
- Grove - Chainable RGB Led
- Grove - Led Bar
- HCSR04 - Ultrasonic Ranging Module
- MCP23017 GPIO Modules
- MCP3008 - Analog Input Modules
- Olimex - Nokia 3310 LCD display
- SmartIC - MCP23017 dual I/O expander
CubieTruck
- GPIO Modules
More program plugins available from contributors at Users' Forum board:
http://www.homegenie.it/forum/index.php?board=3.0