Difference between pages "Templates" and "System"

From meteoplug
(Difference between pages)
Jump to: navigation, search
(Marked this version for translation)
 
 
Line 2: Line 2:
 
<languages /><translate>
 
<languages /><translate>
 
<!--T:1-->
 
<!--T:1-->
<br />Meteobridge provides a very flexible mechanism to smuggle sensor data of different kinds into strings to be used by Meteobrdge push services like Twitter, HTTP GET uploads or MSQL database insert requests.
+
<br />System page provides basic information about your Meteobridge system. Beside selection of time zone and an option to change system password it is mainly a display panel.
Simply type in the text you want to upload and represent the pieces of sensor data by so called variables. When data gets uploaded, these variables will be replaced by current sensor data and so a string filled with the data you intended will be uploaded.
+
  
 
<!--T:2-->
 
<!--T:2-->
Each variable starts with an opening square bracket "[" and is terminated by a closing square bracket "]". The structure of the variable name between these brackets is as follows: <pre>sensor-selector=converter.decimals:replacement</pre>
+
[[File:page3.png]]
"converter", "decimals" and "replacement" can be omitted, "sensor" and "type" are mandatory.
+
While "sensor" tells what sensor and what piece of information of the sensor to use, "selector" decides data from what time period should be taken into account and "converter" does convert data into measurement units the user likes most. "Decimals" decides about precision the result should be shown in and "replacement" gives the string to be returned when there is no data for defined sensor available.
+
  
==Sensors== <!--T:3-->
+
==System== <!--T:3-->
These sensors are defined in Meteobridge.
+
This section gives you information about meteobridge hardware, total RAM capacity and how much of that is already in use, which should not go beyond 90%. It also shows version of used Linux kernel and version of Meteobridge application software.
* '''th0temp''': outdoor temperature in degrees Celsius
+
* '''th0hum''': relative outdoor humidity as percentage
+
* '''th0dew''': outdoor dew point in degrees Celsius
+
* '''thb0temp''': indoor temperature in degrees Celsius
+
* '''thb0hum''': indoor humidity as percentage
+
* '''thb0dew''': indoor dewpoint in degrees Celsius
+
* '''thb0press''': station pressure in hPa
+
* '''thb0seapress''': normalized pressure (computed to sea level) in hPa
+
* '''wind0wind''': wind speed in m/s
+
* '''wind0avgwind''': average windspeed in m/s (time used for average depends on station)
+
* '''wind0dir''': wind direction in degress (0° is North)
+
* '''wind0chill''': wind chill temperature in degrees Celsius
+
* '''rain0rate''': rain rate in mm/h
+
* '''rain0total''': rain fall in mm
+
* '''uv0index''': uv index
+
* '''sol0rad''': solar radiation in W/m^2
+
If a sensor is not there or data of sensor has passed the "tolerated data age" interval, Meteobridge will not provide data for it and will present the value defined as "replacement". If no replacement is given, variable will not be converted into data but will stay as is.
+
  
==Selectors== <!--T:4-->
+
==Security== <!--T:4-->
Sensors are followed by a selector (syntactically separated by a dash) that specifies what period in time should be used for evaluation. Valid selectors are:
+
Security section allows you to change the password that protects meteobridge web interface against unauthorized access. This password is in sync with the password for user root when you try to login via ssh. You can easily change the password by typing in the new password twice.
* '''act''': most recent data
+
* '''hmin''': minimum value of this hour
+
* '''hmax''': maximum value of this hour
+
* '''dmin''': minimum value of today
+
* '''dmax''': maximum value of today
+
* '''ydmin''': minimum value of yesterday
+
* '''ydmax''': maximum value of yesterday
+
* '''mmin''': minimum value of this month
+
* '''mmax''': maximum value of this month
+
* '''ymin''': minimum value of this year
+
* '''ymax''': maximum value of this year
+
* '''amin''': minimum value of all time
+
* '''amax''': maximum value of all time
+
* '''daysum or sumday''', '''monthsum''', '''yearsum''', '''allsum''', '''ydaysum''': selects summerized delta values from today, this month, this year, all time or yesterday: "rain0total-sumday" is todays rain fall.
+
  
<!--T:13-->
+
Smartbedded UG has a feature implemented which allows remote login to a Meteobridge when provided the MAC. This is very usefull for bug fixing, but you can switch this feature off by clearing the mark of corresponding checkbox.
When you are interested in timestamps of min/max values, you can make use of these selectors:
+
* '''hmintime''': timestamp of minimum value of this hour
+
* '''hmaxtime''': timestamp of maximum value of this hour
+
* '''dmintime''': timestamp of minimum value of today
+
* '''dmaxtime''': timestamp of maximum value of today
+
* '''ydmintime''': timestamp of minimum value of yesterday
+
* '''ydmaxtime''': timestamp of maximum value of yesterday
+
* '''mmintime''': timestamp of minimum value of this month
+
* '''mmaxtime''': timestamp of maximum value of this month
+
* '''ymintime''': timestamp of minimum value of this year
+
* '''ymaxtime''': timestamp of maximum value of this year
+
* '''amintime''': timestamp of minimum value of all time
+
* '''amaxtime''': timestamp of maximum value of all time
+
Timestamps are strings of format "YYYYMMDDhhmmss". Year "YYYY" is reported in 4 digits, all other values (month "MM", day "DD", hour "hh", minute "mm", second "ss") come with 2 digits, leading zeros are not supressed.  
+
  
<!--T:5-->
+
==Localization== <!--T:5-->
Apart from selectors that use absolute, predefined time slots there are also selectors that look for a certain amount of time into the past.
+
This sections shows date und time in UTC and in the timezone you have selected. If no timezone is selected Meteobridge takes UTC as you local timezone. Please select timezone matching your weather station's location. When changing timezone a reboot is required to get all system services adapted to this change.
* '''max2''', '''max5''', '''max10''', '''max15''', '''max30''', '''max60''': selects the maximum value from the last 2, 5, 10, 15, 30 or 60 minutes
+
* '''min2''', '''min5''', '''min10''', '''min15''', '''min30''', '''min60''': selects the minimum value from the last 2, 5, 10, 15, 30 or 60 minutes
+
* '''avg2''', '''avg5''', '''avg10''', '''avg15''', '''avg30''', '''avg60''': selects average value from the last 2, 5, 10, 15, 30 or 60 minutes
+
* '''sum2''', '''sum5''', '''sum10''', '''sum15''', '''sum30''', '''sum60''': selects summerized delta values from the last 2, 5, 10, 15, 30 or 60 minutes, which is useful to get amount of total rain in a certain time frame: "rain0total-sum60" is rainfall im mm of last 60 minutes.
+
  
==Converters== <!--T:6-->
+
<!--T:6-->
Sensor data is reported in ISO units (°C, hPa, mm, m/s) by default, but can be converted into non-ISO units (imperial) by adding a conversion token. Defined tokens are:
+
Metebridge's web interface comes in two pre-defined languages, "English" and "German". There will be added more languages over time. If you like to do a translation into your preferred language, you can download a template with "Download Language File" button. Simply fill in the corresponding tranlatin in UTF-8 after the "::" marks and send the file to "info(at)meteobridge.com".
* '''F''' converts temperature from Celsius to Fahrenheit.
+
* '''psi''' converts pressure from hPa (equivalent to mbar) to psi.
+
* '''mmHg''' converts pressure from hPa to millimeters of mercury.
+
* '''inHg''' converts pressure from hPa to inches of mercury.
+
* '''kmh''' converts wind speed from meters per second to kilometers per hour.
+
* '''mph''' converts wind speed from meters per second to miles per hour.
+
* '''kn''' converts wind speed from meters per second to knots.
+
* '''bft''' converts wind speed from meters per second to Beaufort scale.
+
* '''in''' converts millimeters to inches.
+
If an unknown conversion string is used, no conversion will take place, no error message will appear.
+
  
<!--T:14-->
+
<!--T:7-->
When variable returns a timestamp, then this converter can be applied:
+
Some weather networks require coordinates of your weather station. Please enter location by latitude and longitude as decimals. The orange "i" icons do lead you to a web site, where you can easily find out coordinates of any location in the world.
* '''utc''' reports timestamp in UTC instead of localtime, which is default.
+
  
==Special Variables== <!--T:7-->
+
==Network Status== <!--T:8-->
There are a couple of variables that don't come as "sensor-selector=converter" chains but have a distinct meaning by themselves.
+
This section shows IP or WLAN IP used by Meteobridge regarding if meteobridge is working in a cabled or wireless environment. It also displays the system's MAC. You also find network parameters like gateway, netmask and DNS meteobridge is using at the moment. If you have made changes to the network setup, this is not reflected here until Meteobridge is rebooted. WAN IP does report IP your router uses to connect to the Internet. When there is no Internet connection an error message will displayed instead.  
  
<!--T:8-->
+
==Messages== <!--T:9-->
Date und time variables are defined as follows:
+
Messaging section shows system notifications, mainly around status of data logging functions of Meteobridge. When Meteobridge does not work as expected, a look into this log might give hints what goes wrong.
* '''YYYY''': year as four digit number
+
* '''YY''': year as two digit number
+
* '''MM''': month as two digit number, if only one digit neede a zero will be used as first digit
+
* '''M''': month as one or two digit number, no leading zeros
+
* '''DD''': day of month as two digit number, if only one digit neede a zero will be used as first digit
+
* '''D''': day of month as one or two digit number, no leading zeros
+
* '''hh''': hour as two digit number, if only one digit neede a zero will be used as first digit
+
* '''h''': hour as one or two digit number, no leading zeros
+
* '''mm''': minute as two digit number, if only one digit neede a zero will be used as first digit
+
* '''m''': minute as one or two digit number, no leading zeros
+
* '''ss''': seconds as two digit number, if only one digit neede a zero will be used as first digit
+
* '''s''': seconds as one or two digit number, no leading zeros
+
When a capital "U" preceeds a date/time variable name, UTC is used instead of local time ("[Uhh]:[Umm]:[Uss] UTC" is evaluated to a string like "16:03:33 UTC")
+
  
==Decimals== <!--T:9-->
+
==Submit Changes== <!--T:10-->
Unless otherwise defined numbers are reported with one decimal. By specifying a value for "decimals" you can determine resolution of presented values.
+
When you press "Save and Apply" new pasword and timezone settings are stored. Reboot button does not store data, but will initiate a reboot of your Meteobridge device.
 
+
<!--T:15-->
+
When variable returns a string instead of a number (in case of a timestamp for example), "decimal" specification does have a different format and meaning, which allows to select a substring. Specification of the substring consists of two lower-case letters. The first one specifies start point of the substring, second leter the position of last character of the string to be reported. For example, when string is timestamp "20130303121055" a specification of ".ad" selects a substring from first character (position code "a") until fourth character (position code "d"). When you want to grab the time for lowest outdoor temperature of today the template for that will be <font face="Courier"><span style="background-color:lightgrey;">[th0temp-dmintime.ij:--]:[th0temp-dmintime.kl:--]</span></font face>. "ij" selects the hour part at position 9-10 and "kl" selects minute part at position 11-12 of the timestamp.
+
 
+
==Replacement== <!--T:10-->
+
When a variable is not defined or there is no data for a specified sensor, information specified as "replacement" string will be represented instead.
+
 
+
==Examples== <!--T:11-->
+
Having a look at examples usually helps to understand how easy that is.
+
 
+
<!--T:12-->
+
# Template <font face="Courier"><span style="background-color:lightgrey;">Outdoor temperature is [th0temp-act=F.1:--]°F</span></font face> will be converted into <font face="Courier"><span style="background-color:lightgrey;">Outdoor temperature is 3.4°F</span></font face> when there is outdoor temp data and into <font face="Courier"><span style="background-color:lightgrey;">Outdoor temperature is --°F</span></font face> if outdoor temp sensor does not provide recent data.
+
# Template <font face="Courier"><span style="background-color:lightgrey;">Local time is [hh]:[mm]</span></font face> will be converted into <font face="Courier"><span style="background-color:lightgrey;">Local time is 09:27</span></font face>.
+
# Template <font face="Courier"><span style="background-color:lightgrey;">Max gust in last 10 minutes was: [wind0wind-max10.1:--]m/s, [wind0wind-max10=mph.1:--]mph, [wind0wind-max10=kn.0:--]kn</span></font face> will be converted into <font face="Courier"><span style="background-color:lightgrey;">Max gust in last 10 minutes was: 10.5m/s, 23.5mph, 20kn</span></font face>.
+
 
</translate>
 
</translate>

Revision as of 18:46, 17 March 2013

Other languages:
Deutsch • ‎English

System page provides basic information about your Meteobridge system. Beside selection of time zone and an option to change system password it is mainly a display panel.

Page3.png

System

This section gives you information about meteobridge hardware, total RAM capacity and how much of that is already in use, which should not go beyond 90%. It also shows version of used Linux kernel and version of Meteobridge application software.

Security

Security section allows you to change the password that protects meteobridge web interface against unauthorized access. This password is in sync with the password for user root when you try to login via ssh. You can easily change the password by typing in the new password twice.

Smartbedded UG has a feature implemented which allows remote login to a Meteobridge when provided the MAC. This is very usefull for bug fixing, but you can switch this feature off by clearing the mark of corresponding checkbox.

Localization

This sections shows date und time in UTC and in the timezone you have selected. If no timezone is selected Meteobridge takes UTC as you local timezone. Please select timezone matching your weather station's location. When changing timezone a reboot is required to get all system services adapted to this change.

Metebridge's web interface comes in two pre-defined languages, "English" and "German". There will be added more languages over time. If you like to do a translation into your preferred language, you can download a template with "Download Language File" button. Simply fill in the corresponding tranlatin in UTF-8 after the "::" marks and send the file to "info(at)meteobridge.com".

Some weather networks require coordinates of your weather station. Please enter location by latitude and longitude as decimals. The orange "i" icons do lead you to a web site, where you can easily find out coordinates of any location in the world.

Network Status

This section shows IP or WLAN IP used by Meteobridge regarding if meteobridge is working in a cabled or wireless environment. It also displays the system's MAC. You also find network parameters like gateway, netmask and DNS meteobridge is using at the moment. If you have made changes to the network setup, this is not reflected here until Meteobridge is rebooted. WAN IP does report IP your router uses to connect to the Internet. When there is no Internet connection an error message will displayed instead.

Messages

Messaging section shows system notifications, mainly around status of data logging functions of Meteobridge. When Meteobridge does not work as expected, a look into this log might give hints what goes wrong.

Submit Changes

When you press "Save and Apply" new pasword and timezone settings are stored. Reboot button does not store data, but will initiate a reboot of your Meteobridge device.