c_meyer/thingspeak
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

„README.md“ ändern

Browse Source
This commit is contained in:
Christian Meyer 2023-05-19 08:32:43 +02:00
parent 9d4b74d3da
commit 8a28249a88
1 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.textile → README.md
View File

@ -1,6 +1,8 @@
h1. ThingSpeak # ThingSpeak
"ThingSpeak":https://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. [ThingSpeak](https://thingspeak.com) ist eine OpenSource "Internet of Things" Anwendung und API, mit der Daten von "Dingen" per HTTP über das Internet (oder LAN) empfangen und gespeichert werden können. Mit ThingSpeak, kann man verschiedene Anwendungen erstellen, die Sensor-Daten speichern, Standortdaten verwenden oder ein "soziales Netzwerk der Dinge" mit Status Updates versorgt.
Dieser Fork ist dazu gedacht, auf einem eigenen Debian 11 - Server installiert zu werden.
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. 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.
@ -8,60 +10,64 @@ The ThingSpeak application also features time zone management, read/write API ke
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":https://thingspeak.com/docs, and "Tutorials":https://thingspeak.com/docs/tutorials/. 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":https://thingspeak.com/docs, and "Tutorials":https://thingspeak.com/docs/tutorials/.
h3. Before You Begin ### Before You Begin
1. Install Ruby 2, RubyGems, Rails 4, git, and a database like MySQL 1. Install Ruby 2, RubyGems, Rails 4, git, and a database like MySQL
2. Download the application using git: git clone git@github.com:iobridge/thingspeak.git 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 3. Change to the thingspeak directory and install the appropriate gems: sudo bundle install
h3. Configuration ### Configuration
1. Set your database configuration file at config/database.yml (see config/database.yml.example for an example) 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 2. Create the database: rake db:create
3. Create the database tables: rake db:schema:load 3. Create the database tables: rake db:schema:load
h3. Run The Application ### Run The Application
1. Start the server: rails server 1. Start the server: rails server
Your application will now be running at http://localhost:3000/ Your application will now be running at ```http://localhost:3000/```
h2. Changing Application Text ## Changing Application Text
Make changes to config/locales/en.yml Make changes to config/locales/en.yml
To avoid errors, please ensure your lines start with spaces, not tabs. To avoid errors, please ensure your lines start with spaces, not tabs.
Set your application name using the 'application_name' key. Set your application name using the 'application_name' key.
h2. (Optional) Email Setup ## (Optional) Email Setup
Set your domain, user_name, and password in config/environment.rb Set your domain, user_name, and password in config/environment.rb
h2. (Optional) Admin Setup ## (Optional) Admin Setup
Open a rails console: <code>rails console</code> or <code>RAILS_ENV=production rails console</code>, depending on your environment Open a rails console: ```rails console``` or ```RAILS_ENV=production rails console```, depending on your environment
Add the admin user: <code>AdminUser.create!(email: 'YOUR_ADMIN_EMAIL@EXAMPLE.COM', password: 'YOUR_PASSWORD', password_confirmation: 'YOUR_PASSWORD')</code> Add the admin user: ```AdminUser.create!(email: 'YOUR_ADMIN_EMAIL@EXAMPLE.COM', password: 'YOUR_PASSWORD', password_confirmation: 'YOUR_PASSWORD')```
Exit the rails console: <code>exit</code> Exit the rails console: ```exit```
Login via the admin web interface at: "http://YOUR_DOMAIN.COM/admin" Login via the admin web interface at: "http://YOUR_DOMAIN.COM/admin"
h1. Installation on clean install of Ubuntu 12.04 LTS # Installation on clean install of Ubuntu 12.04 LTS
<code>sudo apt-get upgrade</code> ```
<code>sudo apt-get -y install build-essential mysql-server mysql-client libmysqlclient-dev libxml2-dev libxslt-dev git-core curl rubygems</code> sudo apt-get upgrade
<code>\curl -sSL https://get.rvm.io | bash -s stable</code> sudo apt-get -y install build-essential mysql-server mysql-client libmysqlclient-dev libxml2-dev libxslt-dev git-core curl rubygems
<code>rvm install 2.1</code> \curl -sSL https://get.rvm.io | bash -s stable
<code>git clone https://github.com/iobridge/thingspeak.git</code> rvm install 2.1
<code>cd thingspeak</code> git clone https://github.com/iobridge/thingspeak.git
<code>bundle install</code> cd thingspeak
<code>cp config/database.yml.example config/database.yml</code> bundle install
<code>rake db:create</code> cp config/database.yml.example config/database.yml
<code>rake db:schema:load</code> rake db:create
<code>rails server</code> rake db:schema:load
rails server
```
h2. Upgrading existing installations # Upgrading existing installations
<code>git pull origin master</code> ```
<code>bundle install</code> git pull origin master
<code>rake db:migrate</code> bundle install
rake db:migrate
```
If your server is active you can restart it by going to the active terminal, hitting Ctrl-c, and then typing: If your server is active you can restart it by going to the active terminal, hitting Ctrl-c, and then typing:
<code>rails server</code> ```rails server```