Skip to content

Datum Stream List

Show datum stream metadata matching a search filter.

Usage

s10k datum stream list [-U] [-mode=<displayMode>]
                       [-stream=streamId[,streamId...]]...
                       [-source=sourceId[,sourceId...]]...
                       [
                         -node=nodeId[,nodeId...][-node=nodeId[,nodeId...]]... |
                         -loc=locId[,locId...] [-loc=locId[,locId...]]...
                        ]
                       [-prop=propName[,propName...]]...
                       [-a=propName[,propName...]]...
                       [-i=propName[,propName...]]...
                       [-s=propName[,propName...]]...

Options

Option Long Version Description
-stream= --stream-id= the stream ID(s) to show
-node= --node-id= the node ID(s) to show stream metadata for (exclusive to -loc)
-loc= --location-id= the location ID(s) to show stream metadata for (exclusive to -node)
-source= --source= the source ID(s) to show stream metadata for
-prop= --property= restrict results to metadata that has this property (instantaneous, accumulating, or status); multiple properties combine with logical "or"
-i= --instantaneous= restrict results to metadata that has this instantaneous property; multiple properties combine with logical "and"
-a= --accumulating= restrict results to metadata that has this accumulating property; multiple properties combine with logical "and"
-s= --status= restrict results to metadata that has this status property; multiple properties combine with logical "and"
-U --unsorted-names do not sort the property names (preserve physical order); not used with JSON display mode
-mode= --display-mode= the format to display the data as, one of CSV, JSON, or PRETTY; defaults to PRETTY

Output

A listing of all matching stream metadata.

For CSV and PRETTY output the property names are sorted by default. Include the --unsorted-names option to preserve the physical order of the property names. That can be useful when renaming the properties with the datum stream rename command.

Examples

View all datum stream metadata for a node:

s10k datum stream list --node-id 101
+--------------------------------------+------+-----+---------------+------------------+---------------------------------+--------------+--------+
| Stream ID                            | Kind | ID  | Source ID     | Time Zone        | Instantaneous                   | Accumulating | Status |
+--------------------------------------+------+-----+---------------+------------------+---------------------------------+--------------+--------+
| f68e81cd-2ac3-4760-b449-16ebce64c15a | Node | 101 | switch/1      | Pacific/Auckland |                                 |              | val    |
+--------------------------------------+------+-----+---------------+------------------+---------------------------------+--------------+--------+
| 6718cc51-e5fb-43a9-a33f-344bc34916f2 | Node | 101 | power/limit   | Pacific/Auckland | v                               |              | val    |
+--------------------------------------+------+-----+---------------+------------------+---------------------------------+--------------+--------+
| cc114908-cc0f-4680-a92e-718690742ba9 | Node | 101 | gen/1         | Pacific/Auckland | current,frequency,voltage,watts | wattHours    |        |
+--------------------------------------+------+-----+---------------+------------------+---------------------------------+--------------+--------+
Stream ID,Kind,ID,Source ID,Time Zone,Instantaneous,Accumulating,Status
f68e81cd-2ac3-4760-b449-16ebce64c15a,Node,101,switch/1,Pacific/Auckland,,,val
6718cc51-e5fb-43a9-a33f-344bc34916f2,Node,101,power/limit,Pacific/Auckland,v,,val
cc114908-cc0f-4680-a92e-718690742ba9,Node,101,gen/1,Pacific/Auckland,"current,frequency,voltage,watts",wattHours,
[ {
"streamId" : "f68e81cd-2ac3-4760-b449-16ebce64c15a",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "switch/1",
"s" : [ "val" ]
}, {
"streamId" : "6718cc51-e5fb-43a9-a33f-344bc34916f2",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "power/limit",
"i" : [ "v" ],
"s" : [ "val" ]
}, {
"streamId" : "cc114908-cc0f-4680-a92e-718690742ba9",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "gen/1",
"i" : [ "watts", "current", "voltage", "frequency" ],
"a" : [ "wattHours" ]
} ]

View all datum stream metadata for a node that has some property named watts:

s10k datum stream list --node-id 101 --property watts
+--------------------------------------+------+-----+-----------+------------------+------------------------------------------+--------------+--------+
| Stream ID                            | Kind | ID  | Source ID | Time Zone        | Instantaneous                            | Accumulating | Status |
+--------------------------------------+------+-----+-----------+------------------+------------------------------------------+--------------+--------+
| cc114908-cc0f-4680-a92e-718690742ba9 | Node | 101 | gen/1     | Pacific/Auckland | current,frequency,voltage,watts          | wattHours    |        |
+--------------------------------------+------+-----+-----------+------------------+------------------------------------------+--------------+--------+
| 0c0fc45d-1e96-40cb-8aa0-07619b3158fd | Node | 101 | con/pcm   | Pacific/Auckland | current,frequency,pcmLimit,voltage,watts | wattHours    |        |
+--------------------------------------+------+-----+-----------+------------------+------------------------------------------+--------------+--------+
| 03c6bd01-9241-4771-ad3c-a1d5eb06b68a | Node | 101 | con/1     | Pacific/Auckland | current,frequency,pcmLimit,voltage,watts | wattHours    |        |
+--------------------------------------+------+-----+-----------+------------------+------------------------------------------+--------------+--------+
Stream ID,Kind,ID,Source ID,Time Zone,Instantaneous,Accumulating,Status
cc114908-cc0f-4680-a92e-718690742ba9,Node,101,gen/1,Pacific/Auckland,"current,frequency,voltage,watts",wattHours,
0c0fc45d-1e96-40cb-8aa0-07619b3158fd,Node,101,con/pcm,Pacific/Auckland,"current,frequency,pcmLimit,voltage,watts",wattHours,
03c6bd01-9241-4771-ad3c-a1d5eb06b68a,Node,101,con/1,Pacific/Auckland,"current,frequency,pcmLimit,voltage,watts",wattHours,
[ {
"streamId" : "cc114908-cc0f-4680-a92e-718690742ba9",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "gen/1",
"i" : [ "watts", "current", "voltage", "frequency" ],
"a" : [ "wattHours" ]
}, {
"streamId" : "0c0fc45d-1e96-40cb-8aa0-07619b3158fd",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "con/pcm",
"i" : [ "watts", "current", "voltage", "pcmLimit", "frequency" ],
"a" : [ "wattHours" ]
}, {
"streamId" : "03c6bd01-9241-4771-ad3c-a1d5eb06b68a",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "con/1",
"i" : [ "watts", "current", "voltage", "frequency", "pcmLimit" ],
"a" : [ "wattHours" ]
} ]

View all datum stream metadata that has an instantaneous property named pcmLimit and an accumulating property named wattHours:

s10k datum stream list --instantaneous pcmLimit \
  --accumulating wattHours
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
| Stream ID                            | Kind | ID  | Source ID | Time Zone        | Instantaneous                                                                  | Accumulating      | Status |
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
| 2e16deac-bd95-4d4b-9668-4441f48aea17 | Node |  64 | /meter/1  | Pacific/Auckland | apparentPower,current,frequency,phaseVoltage,powerFactor,reactivePower,realPow | wattHours         |        |
|                                      |      |     |           |                  | er,voltage,watts                                                               |                   |        |
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
| a73f4797-d9aa-4496-b96c-04ad934b1550 | Node |  64 | /meter/2  | Pacific/Auckland | apparentPower,current,frequency,phaseVoltage,powerFactor,reactivePower,realPow | wattHours         |        |
|                                      |      |     |           |                  | er,voltage,watts                                                               |                   |        |
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
| 2d19d690-2472-480d-afc0-240f830d4cd5 | Node |  70 | meter/1   | Pacific/Auckland | current,frequency,voltage,watts                                                | wattHours,wh_half |        |
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
| 03c6bd01-9241-4771-ad3c-a1d5eb06b68a | Node | 101 | con/1     | Pacific/Auckland | current,frequency,pcmLimit,voltage,watts                                       | wattHours         |        |
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
| 0c0fc45d-1e96-40cb-8aa0-07619b3158fd | Node | 101 | con/pcm   | Pacific/Auckland | current,frequency,pcmLimit,voltage,watts                                       | wattHours         |        |
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
| cc114908-cc0f-4680-a92e-718690742ba9 | Node | 101 | gen/1     | Pacific/Auckland | current,frequency,voltage,watts                                                | wattHours         |        |
+--------------------------------------+------+-----+-----------+------------------+--------------------------------------------------------------------------------+-------------------+--------+
Stream ID,Kind,ID,Source ID,Time Zone,Instantaneous,Accumulating,Status
2e16deac-bd95-4d4b-9668-4441f48aea17,Node,64,/meter/1,Pacific/Auckland,"apparentPower,current,frequency,phaseVoltage,powerFactor,reactivePower,realPower,voltage,watts",wattHours,
a73f4797-d9aa-4496-b96c-04ad934b1550,Node,64,/meter/2,Pacific/Auckland,"apparentPower,current,frequency,phaseVoltage,powerFactor,reactivePower,realPower,voltage,watts",wattHours,
2d19d690-2472-480d-afc0-240f830d4cd5,Node,70,meter/1,Pacific/Auckland,"current,frequency,voltage,watts","wattHours,wh_half",
03c6bd01-9241-4771-ad3c-a1d5eb06b68a,Node,101,con/1,Pacific/Auckland,"current,frequency,pcmLimit,voltage,watts",wattHours,
0c0fc45d-1e96-40cb-8aa0-07619b3158fd,Node,101,con/pcm,Pacific/Auckland,"current,frequency,pcmLimit,voltage,watts",wattHours,
cc114908-cc0f-4680-a92e-718690742ba9,Node,101,gen/1,Pacific/Auckland,"current,frequency,voltage,watts",wattHours,
[ {
"streamId" : "2e16deac-bd95-4d4b-9668-4441f48aea17",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 64,
"sourceId" : "/meter/1",
"i" : [ "watts", "current", "voltage", "frequency", "realPower", "powerFactor", "phaseVoltage", "apparentPower", "reactivePower" ],
"a" : [ "wattHours" ]
}, {
"streamId" : "a73f4797-d9aa-4496-b96c-04ad934b1550",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 64,
"sourceId" : "/meter/2",
"i" : [ "watts", "current", "voltage", "frequency", "realPower", "powerFactor", "phaseVoltage", "apparentPower", "reactivePower" ],
"a" : [ "wattHours" ]
}, {
"streamId" : "2d19d690-2472-480d-afc0-240f830d4cd5",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 70,
"sourceId" : "meter/1",
"i" : [ "watts", "current", "voltage", "frequency" ],
"a" : [ "wattHours", "wh_half" ]
}, {
"streamId" : "03c6bd01-9241-4771-ad3c-a1d5eb06b68a",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "con/1",
"i" : [ "watts", "current", "voltage", "frequency", "pcmLimit" ],
"a" : [ "wattHours" ]
}, {
"streamId" : "0c0fc45d-1e96-40cb-8aa0-07619b3158fd",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "con/pcm",
"i" : [ "watts", "current", "voltage", "pcmLimit", "frequency" ],
"a" : [ "wattHours" ]
}, {
"streamId" : "cc114908-cc0f-4680-a92e-718690742ba9",
"zone" : "Pacific/Auckland",
"kind" : "n",
"objectId" : 101,
"sourceId" : "gen/1",
"i" : [ "watts", "current", "voltage", "frequency" ],
"a" : [ "wattHours" ]
} ]