Differences

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

--- iapi:start [2013/10/20 13:01] – created kyrahabattoir
+++ iapi:start [2015/11/25 15:39] (current) – kyrahabattoir
@@ Line 14: / Line 14: @@
   * Clicking a pile of sand with an empty bucket in hand will fill it up with sand.
   * Clicking a drain grate with a bucket of liquid will empty the bucket.
+====== The tracking API ======
+Some objects will have a specific description format that you can read to track its status in real time:
+<code>IAPI, LABEL, 0, 10, LABEL2, 5, 100, ..., LABELN, valueN, maxN,</code>
+This is a CSV list of parameters, under the following rules:
+  * header: "IAPI" This marks the description as IAPI compatible.
+  * index +0: <text> This is the "label" of the first entry, essentially, what it is, some devices have a hardcoded labels.
+  * index +1: <int> The raw value for the first label.
+  * index +2: <int> The maximum value for the first label.
+  * index N:  <text> Some devices have multiple values, this is the label for the next value.
+  * index N+1:<int> The raw value for the current label.
+  * index N+2:<int> The maximum value for the current label.