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 [2013/11/24 10:54] – [xAP Xively] brettlivebox:pachube [2014/11/08 09:41] (current) – [As a Service] brett
Line 14: Line 14:
 The Max and Min values are used by xively to perform graph scaling along with the Unit field to annotate the datastream. The Max and Min values are used by xively to perform graph scaling along with the Unit field to annotate the datastream.
  
-===== The operation of the xap-xively feeder=====+===== The operation of the xap-xively feeder =====
  
-Let consider an example of pushing a 1wire temperature sensor data value to Xively.+Let'consider an example of pushing a 1wire temperature sensor data value to Xively.
  
-The temperatures sensors are generating an event on every .1 degree of a change, however data to xively is only pushed every minute.  The way this timing difference is resolve is for xap-xively to monitor all the events and constantly update its internal cache to record the value.  When the time comes to push a new reading to xively the last value from each sensor is +The temperatures sensors are generating an event on every .1 degree of a change, however data to xively is only pushed, by default, every minute.  The way this timing difference is resolved is for xap-xively to monitor all the events and constantly update its internal cache to record the value.  When the time comes to push a new reading the last value from the sensor is 
-pushed up.+used.
  
-If you temperature hovers from 15.5->15.8->15.5 its possible that 15.8 won't be see if this wasn't the latest value.   You're temperatures reading have to change and hold for at least a minute before you'll see something different being reported to xively.+If your temperature hovers from 15.5->15.8->15.5 its possible that 15.8 won't be see if this wasn't the last value.  Your temperatures readings have to change and hold for at least the reporting period before you'll see something different being reported to xively.  The reporting period in effect becomes a hysteresis of sorts.
 ===== Sample mapping ===== ===== Sample mapping =====
  
Line 78: Line 78:
 Its internal cache of data to push to XIVELY can be updated by xAP messages being targeted at this service. Its internal cache of data to push to XIVELY can be updated by xAP messages being targeted at this service.
  
-Messages sent to it are not immediately forwarded to the XIVELY service. They wait until the next update cycle.+Messages sent to it are not immediately forwarded to the XIVELY service. They wait until the next update cycle, unless the **now** attribute is supplied more on that later.
  
 A Xively update message looks like this: A Xively update message looks like this:
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.
 +
 +<code>
 +datastream
 +{
 +id=4
 +tag=Outside light on
 +value=1
 +now=1
 +}
 +</code>
 +
 +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.1385290494.txt.gz
  • Last modified: 2013/11/24 10:54
  • by brett