thingspeak/README.textile

85 lines
3.6 KiB
Plaintext
Raw Normal View History

2011-03-27 22:53:05 +02:00
h1. ThingSpeak
2011-03-28 03:20:20 +02:00
"ThingSpeak":http://www.thingspeak.com is an open source “Internet of Things” application and API to store and retrieve data from things using HTTP over the Internet or via a Local Area Network. With ThingSpeak, you can create sensor logging applications, location tracking applications, and a social network of things with status updates.
2011-03-28 01:10:22 +02:00
In addition to storing and retrieving numeric and alphanumeric data, the ThingSpeak API allows for numeric data processing such as timescaling, averaging, median, summing, and rounding. Each ThingSpeak Channel supports data entries of up to 8 data fields, latitude, longitude, elevation, and status. The channel feeds support JSON, XML, and CSV formats for integration into applications.
The ThingSpeak application also features time zone management, read/write API key management and JavaScript-based charts from Highslide Software / Torstein Hønsi.
2011-03-28 03:29:24 +02:00
Support for ThingSpeak is available on the "ThingSpeak Community":http://community.thingspeak.com/ site which features a "Blog":http://community.thingspeak.com/, "Forum":http://community.thingspeak.com/forum/, "Documentation":http://community.thingspeak.com/documentation/, and "Tutorials":http://community.thingspeak.com/tutorials/.
2011-03-27 22:53:05 +02:00
h3. Before You Begin
2011-03-27 22:54:00 +02:00
2011-03-28 22:46:14 +02:00
1. Install Ruby, RubyGems, Rails 3, git, and a database like MySQL
2. Download the application using git: git clone git@github.com:iobridge/thingspeak.git
3. Change to the thingspeak directory and install the appropriate gems: sudo bundle install
2011-03-27 22:53:05 +02:00
h3. Configuration
2011-03-27 22:54:00 +02:00
2011-03-27 22:53:05 +02:00
1. Set your database configuration file at config/database.yml (see config/database.yml.example for an example)
2. Create the database: rake db:create
2011-03-28 02:04:02 +02:00
3. Create the database tables: rake db:schema:load
2011-03-27 22:53:05 +02:00
h3. Run The Application
2011-03-27 22:54:00 +02:00
2011-03-27 22:53:05 +02:00
1. Start the server: rails server
2011-03-28 05:30:55 +02:00
2011-03-27 22:53:05 +02:00
Your application will now be running at http://localhost:3000/
h2. Changing Application Text
2011-03-27 22:54:00 +02:00
2011-03-27 22:53:05 +02:00
Make changes to config/locales/en.yml
To avoid errors, please ensure your lines start with spaces, not tabs.
Set your application name using the 'application_name' key.
2011-04-02 00:57:24 +02:00
h2. (Optional) Memcached Support and Rate Limiting
Please see our "official memcached fork":https://github.com/llawlor/thingspeak
2011-04-02 00:57:49 +02:00
2011-03-27 22:53:05 +02:00
h2. (Optional) HTTP GET Support
2011-03-27 22:54:00 +02:00
2011-03-27 22:53:05 +02:00
By default the application will accept channel updates via GET or POST. To only allow POSTs, change the value of GET_SUPPORT found in config/initializers/constants.rb
h2. (Optional) Email Setup
2011-03-27 22:54:00 +02:00
2011-03-27 22:53:05 +02:00
Set your domain, user_name, and password in config/environment.rb
2011-03-29 02:28:18 +02:00
Also set your password reset link in app/controllers/mailer.controller.rb line 14 (and uncomment the line)
2011-11-25 10:50:42 +01:00
h1. Installation on clean install of Ubuntu 10.10 and 11.10
2011-03-29 02:28:18 +02:00
2011-03-29 02:31:18 +02:00
Start Terminal
cd ~
2011-03-29 02:28:18 +02:00
sudo apt-get install aptitude
sudo aptitude update
sudo aptitude install build-essential git-core curl
2011-11-25 10:50:42 +01:00
bash < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer )
echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm" # Load RVM function' >> ~/.bash_profile
source .bash_profile
2011-03-29 02:28:18 +02:00
sudo aptitude install mysql-server libmysqlclient-dev libmysql-ruby
2011-11-25 11:37:01 +01:00
Note: Enter and confirm a new MySQL password
2011-03-29 02:28:18 +02:00
sudo aptitude install libssl-dev libopenssl-ruby libxslt1.1 libxslt1-dev libxml2 libxml2-dev rubygems
2011-11-25 12:03:32 +01:00
rvm pkg install openssl
rvm pkg install iconv
2011-11-25 12:10:24 +01:00
rvm install 1.9.2 -C --with-openssl-dir=$HOME/.rvm/usr, --with-iconv-dir=$HOME/.rvm/usr
2011-11-25 11:01:34 +01:00
rvm use 1.9.2
2011-03-29 02:28:18 +02:00
git clone git://github.com/iobridge/thingspeak.git
cd thingspeak
bundle install
gedit config/database.yml.example
Note: Change database username and password for development, test, and production databases and save the file as database.yml
rake db:create
rake db:schema:load
rails server