livebox:pachube

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
livebox:pachube [2014/11/08 09:28] – [As a Service] brettlivebox:pachube [2014/11/08 09:41] (current) – [As a Service] brett
Line 100: Line 100:
  
 In the message above In the message above
- * The id= key matches that of the ID field in the datastream for the default Feed ID. +  * The id= key matches that of the ID field in the datastream for the default Feed ID. 
- * The tag=key updates the tag value of the datastream identified by the ID key/field +  * The tag=key updates the tag value of the datastream identified by the ID key/field 
- * The value updates the value of the datastream identified by the ID key/field+  * The valueupdates the value of the datastream identified by the ID key/field 
 + 
 +The attributes; id, tag and value are mandatory and must be supplied with each xAP message.
  
 The configuration page on the HAH xively tab is unaffected The configuration page on the HAH xively tab is unaffected
  
 Note that the UID and source in the message above must either both have sub-addresses or neither have sub addresses Note that the UID and source in the message above must either both have sub-addresses or neither have sub addresses
 +
 +==== now attribute ====
 +
 +This is an optional attribute.
  
 If you require the manual feed to update xively immediately the xively.update is sent supply the attribute "now" with a value 1. If you require the manual feed to update xively immediately the xively.update is sent supply the attribute "now" with a value 1.
Line 122: Line 128:
 The **now** field was added to solve the use case where by a boolean value needs to be monitored and its state should not be cached as it may toggle before the next xively web service update occurs.  It will cause xap-xively to immediately push the value up to the xively web server. The **now** field was added to solve the use case where by a boolean value needs to be monitored and its state should not be cached as it may toggle before the next xively web service update occurs.  It will cause xap-xively to immediately push the value up to the xively web server.
  
 +==== feed attribute ====
 +
 +This is an optional attribute.
 +
 +When feeding xap-xively manually you may supply a feed attribute to override the default feedid= setting obtained from the /etc/xap.d/xap-xively.ini file.
 +
 +<code>
 +datastream
 +{
 +id=4
 +tag=Humidity
 +value=60
 +feed=1234
 +}
 +</code>
 +
 +==== min/max attribute ====
 +
 +These are optional attributes.
 +
 +When feeding xap-xively manually you may supply a min/max attribute to specify to the xively backend the range of values to be expected.  This assists it with graphing.
 +
 +<code>
 +datastream
 +{
 +id=4
 +tag=Temperature
 +value=20
 +min=-10
 +max=40
 +}
 +</code>
 +
 +
 +==== unit attribute ====
 +
 +This is an optional attribute.
 +
 +This attribute allows you to supply a textual hint for the unit type of the value.  Its purpose is to document the value units when viewing graphs and values through the xively web interface.
 +
 +<code>
 +datastream
 +{
 +id=4
 +tag=Pressure
 +value=973
 +unit=hPa
 +}
 +</code>
 ===== Graphing ===== ===== Graphing =====
  
  • livebox/pachube.1415438890.txt.gz
  • Last modified: 2014/11/08 09:28
  • by brett