File	Date	Author	Commit
.idea	2011-02-27	Aleksander Kwiatkowski	[5fe9ec] concurrency problem when fixing ids for cities ...
trunk	2011-12-18	Aleksander Kwiatkowski	[c1e04e] how to stare plasmoid viewer
README.rdoc	2011-02-03	Aleksander Kwiatkowski	[49e4da] started backend documentation

Read Me

= HomeIO

== What is it?

Main goal is to create not expensive system for home users to help monitor, control and optimize various tasks such as heating or lights.
It has to be universal, easy to develop new features, and gain more remote control than basic home automation systems. Universal means that
user should be able to use it for everything that can be monitored and controlled. Is there sensor? Yes? You can use it!

HomeIO is a mix of my two projects:
a. Wind turbine control system - multilayer (hardware firmware, pc deamon, and web app) software for ensuring safety of wind turbine, control it without need of human influence.
b. MetarLogger G. Win - tool for storing METAR weather data and creating graphs.

...but this is not a merge of two projects. It is recreated version which utilize code and ideas from this two projects with a lot of new features. 

It is not something unreal - my wind control system works from 2008 and has nearly 30 million of measurements. This is photo of hardware
http://www.flickr.com/photos/32921659@N03/5090655232/sizes/l/in/photostream/ for that project.

== What is it now?

Current version is something like alpha with limited functions. It has only:
a. metar logging
b. weather logging with future prediction
c. storing in DB using active record
d. use gadu-gadu and jabber account as bot
e. some data processing (min, max, avg weather information)
f. simple IO server to communicate with microcontroller via RS232 (not integrated)

Features may vary.

== Requirements

Requirements may vary. It is early stage so I'm concentrated more on features
and bugs, and requirements tend to change more rapidly.

List of required software:

1. Requirements:
a. Ruby 1.8.7
b. Gems required. Prefered version in parenthesis.
- activemodel (3.0.3)
- activerecord (3.0.3)
- activesupport (3.0.3)
- geokit (1.5.0)
- jabber4r (0.8.0)
- mkrf (0.2.3)
- mysql (2.8.1)
- rgadu (0.2.1)
- sqlite3-ruby (1.3.2)
- xmpp4r (0.5)

== How to use?

1. install Ruby and gems
2. check config files (./config/*) and try get to know the project, most important files at start are:
a. Geolocation.yml - set your geographic coords here
b. MetarLogger.yml - choose cities which you are interested in if default set is not good enough
c. StorageActiveRecord.yml - choose sqlite, mysql or other Active Record capable database, and set configuration here. Just like in Rails.
d. WeatherInteriaPl.yml, WeatherOnetPl.yml, WeatherWpPl.yml - you can set places to log weather using some popular Polish portals
3. Create database, not schema
4. Run 'rake db:init' - it should create and populate tables
5. Run app:
a. 'rake supervisor:start' - it will start server which listen to commands
b. 'rake action:fetch_metar' - fetch metars set in  MetarLogger.yml
c. 'rake action:fetch_weather' - fetch weather data using WeatherRipper using (at this moment) some popular polish portals
d. 'rake client:fetch_metar' - send command to server started by 'rake supervisor:start', and make it do 'rake action:fetch_metar'
e. 'rake client:fetch_weather' - send command to server started by 'rake supervisor:start', and make it do 'rake action:fetch_weather'

== Licence

As code and LICENCE stands - everything is in GPLv3. I'm not going to change it or close the project.

== Help and contribution

Other command are available after running 'rake -T'. If you have problems you can mail me login 'bobikx' and the server is 'poczta.fm'.
Feel free to post bugs, feature reports, or (wishful thinking :] ) contribution offer at https://sourceforge.net/projects/homeio/