1. 75F Renatus
  2. Internal
  3. General Concepts

Haystack Filters & Queries

Mahalingam Chandrasekar
  • Updated

browse

| Overview

The Haystack Ontology and semantics is used for all data within 75F adopted haystack data world. The way the tags work and the kind of operations and filters that is supported needs to be understood, so that it becomes easy for the users to optimally use and advocate tags within our system.

75F feature and tools provide many options, where Users who are familiar with pseudo codes and query languages can build custom queries to see particular data points and values using the external API's portal and Developer portals. And also use the filtered out different sets of data points to plot in a visualization, as a part of the Heatmap and PAM custom visualization. So getting to know how to use Haystack filters will enrich Users data viewing and tool customization capabilities. 

Understanding and learning this feature will ease various tools usage and will enable Users to make optimal robust queries instead of inbuilt query sets.

| Filter Function

The FILTER function "filters" a range of data, based on supplied criteria. The filter function is specifically used in the developer portal of 75F system, The result is an array of matching values from the original range. In plain language, the FILTER function will extract matching records from a set of data by applying one or more logical tests.

Note: The FILTER function does not have any effect in Heatmap & PAM visualizations.

Haystack Filters usage instead of standard built in Query options allows for

  • Filters operate quickly and are good for limiting the number of points.
  • Haystack filter language has keywords for comparing with standard operators which is easy to learn and use.
  • Allows for customized and granular queries to be built on various operators.

Filters are query constructs that can be used along with all the operators. Filters allow a simple declarative language to query Haystack data. A filter is a predicate function that takes a dict and returns true/false (match/no match). Some filter constructs require the use of defs in which case the filter must be evaluated in the context of a namespace.

blobid1.png

Grammar currently used in Haystack [Zinc] : refer https://project-haystack.org/doc/docHaystack/Filters

| Operations in Haystack

The common standardized operations of the Haystack HTTP API are

  • Read
  • pointwrite
  • pointwriteMany
  • hisRead
  • hisReadMany

| Filters and the Operators that are Allowed

Tag name Operator

The simplest filter is just a tag name that matches any record that contains that tag (regardless of its value)

 

Equality or comparison operators

<expr> == <expr>

Compare for equals,

 
<expr> != <expr>

not equals

 
<expr> > <expr>

greater than

 
<expr> < <expr>

less than

 
<expr> >= <expr>

greater than or equal

 
<expr> <= <expr>

less than or equal.

Where <expr> can be tag or value or another expression.

 

Logical operators

Operator Description

not

Returns true if right operand is false. Otherwise, returns false.

exists

Returns false if right operand is null. Otherwise, returns true.

and

Returns true if both operands are true. Otherwise, returns false.

or

 Returns true if any operand is true. Otherwise, returns false.

 

| Sample Custom Queries for Developer Portal

  • To Fetch all Sites in a environment using read:

Query

filter
"site"

Result

{
"id": "r:5ee3bcc9c601d557f8824858",
"area": "n:10000 ft²",
"dis": "madhu_06_12",
"fmEmail": "madhushan@75f.io",
"geoAddr": "700 University Ave SE",
"geoCity": "Minneapolis",
"geoCoord": "c:44.983039,-93.246128",
"geoCountry": "USA",
"geoPostalCode": "55414",
"geoState": "MN",
"installerEmail": "madhushan@75f.io",
"organization": "75F",
"site": "m:",
"tz": "Chicago",
"weatherRef": "r:5ee3bccbc601d557f8824859"
},
{
"id": "r:5ee3cb82c601d557f88249bb",
"area": "n:10000 ft²",
"dis": "DaikinHyperStatDemo",
"fmEmail": "samjith@75f.io",
"geoAddr": "SouthPoint",
"geoCity": "Bloomington",
"geoCountry": "US",
"geoPostalCode": "55435",
"geoState": "MN",
"installerEmail": "samjith@75f.io",
"organization": "75F",
"site": "m:",
"tz": "Chicago"
},
{
"id": "r:5ee90b76c601d557f88264ce",
"area": "n:10000 ft²",
"dis": "DemoHS",
"fmEmail": "samjith@75f.io",
"geoAddr": "7350",
"geoCity": "Edina",
"geoCoord": "c:44.869503,-93.332209",
"geoCountry": "us",
"geoPostalCode": "55435",
"geoState": "mn",
"installerEmail": "samjith@75f.io",
"organization": "75F",
"site": "m:",
"tz": "Chicago",
"weatherRef": "r:5ee3cbb2c601d557f88249bc"
},
  • To Fetch all site points with read:

Query

filter
"siteRef==’@siteRef"

Example

filter
"siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Result

{
"id": "r:244d7dc0-8021-4108-ac7c-12c9e9d9021d",
"dis": "Floor 1",
"floor": "m:",
"floorNum": "n:0",
"orientation": "n:0",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:1d324c1c-7624-4d38-b9fa-6fe940afa430",
"dis": "Product Home-BuildingTuner",
"equip": "m:",
"floorRef": "r:SYSTEM",
"roomRef": "r:SYSTEM",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"tuner": "m:",
"tz": "Colombo"
},
{
"id": "r:523d6448-5021-4962-afc0-9e0446e111db",
"cooling": "m:",
"deadband": "m:",
"default": "m:",
"dis": "Product Home-BuildingTuner-DualDuct-coolingDeadbandMultiplier",
"dualDuct": "m:",
"equipRef": "r:1d324c1c-7624-4d38-b9fa-6fe940afa430",
"floorRef": "r:SYSTEM",
"his": "m:",
"hisInterpolate": "cov",
"incrementVal": "n:0.1",
"kind": "Number",
"maxVal": "n:5",
"minVal": "n:0.5",
"multiplier": "m:",
"point": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"tuner": "m:",
"tunerGroup": "DAB",
"tz": "Colombo",
"writable": "m:"
},
{
"id": "r:c4197429-93c6-462d-85e0-ca5a8d17d8e7",
"airflow": "m:",
"cooling": "m:",
"default": "m:",
"dis": "Product Home-BuildingTuner-stage4CoolingAirflowTempLowerOffset",
"equipRef": "r:1d324c1c-7624-4d38-b9fa-6fe940afa430",
"floorRef": "r:SYSTEM",
"his": "m:",
"hisInterpolate": "cov",
"incrementVal": "n:1",
"kind": "Number",
"lower": "m:",
"maxVal": "n:0",
"minVal": "n:-150",
"offset": "m:",
"point": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"stage4": "m:",
"temp": "m:",
"tuner": "m:",
"tunerGroup": "ALERT",
"tz": "Colombo",
"unit": "°F",
"writable": "m:"
},
  • To Fetch Floors associated to selected site using read:

Query

filter
"floor and siteRef==@siteRef"

Example

filter
"floor and siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Result

{
"id": "r:244d7dc0-8021-4108-ac7c-12c9e9d9021d",
"dis": "Floor 1",
"floor": "m:",
"floorNum": "n:0",
"orientation": "n:0",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:ba4dbba5-6610-47a0-8f5d-ae23f603869c",
"dis": "Floor 2",
"floor": "m:",
"floorNum": "n:0",
"orientation": "n:0",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:23c0a49a-7f18-41ae-917e-5a631789f128",
"dis": "Floor 4",
"floor": "m:",
"floorNum": "n:0",
"orientation": "n:0",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"writable": "m:"
},
{
"id": "r:aa40026c-b85d-4953-a512-216771a06110",
"dis": "floor_7",
"floor": "m:",
"floorNum": "n:0",
"orientation": "n:0",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"writable": "m:"
}
  • To Fetch zones list through siteRef using read:

Query

filter
"room and siteRef==@siteRef"

Example

filter
"room and siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Result

{
"id": "r:4d51391a-f7f4-4038-b697-b95b28a3cb07",
"dis": "Server Room",
"floorRef": "r:244d7dc0-8021-4108-ac7c-12c9e9d9021d",
"room": "m:",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:e82ce61e-90b9-4d5d-ab99-729da22cd38e",
"dis": "Conference Room 1",
"floorRef": "r:244d7dc0-8021-4108-ac7c-12c9e9d9021d",
"room": "m:",
"scheduleRef": "r:dbf88839-3081-4029-aa52-630e66881498",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:c6aca63e-0951-4c52-8a62-5025291e9db0",
"dis": "Cafeteria",
"floorRef": "r:244d7dc0-8021-4108-ac7c-12c9e9d9021d",
"room": "m:",
"scheduleRef": "r:86397c58-1c66-4ae0-9593-b220a4e74cda",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:c77d74a8-3804-4394-a385-e08eb5612acd",
"dis": "AHU Room 1",
"floorRef": "r:244d7dc0-8021-4108-ac7c-12c9e9d9021d",
"room": "m:",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
  • To Fetch the pointRead data using hisReadMany:

Query

ver:"3.0" hisStart:2022-06-06THH:MM:SS-05:MS <timezone> 
hisEnd:YYYY-MM-06THH:MM:SS-05:MS <timezone>
id
@Id1
@Id2
@Id3

Example

ver:"3.0" hisStart:2022-06-06T00:00:00-05:00 Colombo hisEnd:2022-06-06T23:59:59-05:00 Colombo
id
@78de57d1-5888-471b-988f-0f8c8c4d5b56
@49910d4b-b9a1-4adf-9886-5524102e0351
@26413f18-75eb-4794-8f1e-4bd6e37d1e70

Result

{
"id": "r:78de57d1-5888-471b-988f-0f8c8c4d5b56",
"air": "m:",
"cpu": "m:",
"cur": "m:",
"current": "m:",
"data": [
{
"d": "n:0",
"time": "t:2022-06-06T12:58:40.450Z"
},
{
"d": "n:82.3",
"time": "t:2022-06-06T12:58:50.229Z"
},
{
"d": "n:82.4",
"time": "t:2022-06-06T13:00:10.283Z"
},
{
"d": "n:82.6",
"time": "t:2022-06-06T13:00:50.228Z"


{
"id": "r:49910d4b-b9a1-4adf-9886-5524102e0351",
"air": "m:",
"cur": "m:",
"current": "m:",
"data": [
{
"d": "n:0",
"time": "t:2022-06-06T13:00:16.308Z"
},
{
"d": "n:84.1",
"time": "t:2022-06-06T13:01:04.936Z"
},
{
"d": "n:84.2",
"time": "t:2022-06-06T13:02:24.901Z"
},
{
"d": "n:84.3",
"time": "t:2022-06-06T13:03:44.968Z"
},
{
"d": "n:84.2",
"time": "t:2022-06-06T13:07:05.222Z"
},
{
"d": "n:84.3",
"time": "t:2022-06-06T13:08:25.350Z"
},


{
"id": "r:26413f18-75eb-4794-8f1e-4bd6e37d1e70",
"air": "m:",
"cur": "m:",
"current": "m:",
"data": [
{
"d": "n:0",
"time": "t:2022-06-06T13:01:56.182Z"
},
{
"d": "n:85.5",
"time": "t:2022-06-06T13:03:08.503Z"
},
{
"d": "n:80.2",
"time": "t:2022-06-06T13:03:21.335Z"
},
{
"d": "n:80.3",
"time": "t:2022-06-06T13:04:41.500Z"
},
{
"d": "n:80.4",
"time": "t:2022-06-06T13:05:21.652Z"
},
{
"d": "n:80.2",
"time": "t:2022-06-06T13:06:01.773Z"
},
{
"d": "n:80.1",
"time": "t:2022-06-06T13:14:03.186Z"
},
{
"d": "n:80.1",
"time": "t:2022-06-06T13:15:59.440Z"
},
{
"d": "n:80",
"time": "t:2022-06-06T13:17:23.793Z"
},
{
"d": "n:79.9",
"time": "t:2022-06-06T13:18:44.082Z"
},
  • To Fetch the CCU details using read:

Query

filter
"ccu and siteRef==@siteRef"

Example

filter
"ccu and siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Result

{
"id": "r:049276c4-ab74-4386-a14e-840ca922be4b",
"ahuRef": "r:b562dd75-2d0f-44a1-80c2-3efbe0201bea",
"ccu": "m:",
"createdDate": "d:2022-01-17",
"device": "m:",
"dis": "L1_CCU1",
"equipRef": "r:a2cf41fb-8047-47e3-a318-e5851d12107b",
"fmEmail": "rajat@75f.io",
"gatewayRef": "r:b562dd75-2d0f-44a1-80c2-3efbe0201bea",
"installerEmail": "installer@75f.io",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:b0f9f766-c4d5-4167-b016-07421ac81086",
"ahuRef": "r:355fdc83-7faa-41eb-84b7-8ca0dd5f84aa",
"ccu": "m:",
"createdDate": "d:2022-03-30",
"device": "m:",
"dis": "L3_AHU66",
"equipRef": "r:d0a46b33-d477-496e-8d41-5fd479b77074",
"fmEmail": "rajat@75f.io",
"gatewayRef": "r:355fdc83-7faa-41eb-84b7-8ca0dd5f84aa",
"installerEmail": "installer@75f.io",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:76596a1a-2fd6-4806-b3b4-ccaee152b0c9",
"ahuRef": "r:419150ff-1193-432e-9a8d-19cfdadc7895",
"ccu": "m:",
"createdDate": "d:2022-05-04",
"device": "m:",
"dis": "L2_CCU2",
"equipRef": "r:2ddb9998-7311-467b-a4eb-6373c0915140",
"fmEmail": "rajat@75f.io",
"gatewayRef": "r:419150ff-1193-432e-9a8d-19cfdadc7895",
"installerEmail": "installer@75f.io",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:b1468bc0-e022-4e42-baa7-2eca93f9f5b1",
"ahuRef": "r:17a25075-710f-447a-8c6c-1559767e03ad",
"ccu": "m:",
"createdDate": "d:2022-06-06",
"device": "m:",
"dis": "L7_AHU7",
"equipRef": "r:c0b102e3-0d25-4848-941e-708158ef3baf",
"fmEmail": "rajat@75f.io",
"gatewayRef": "r:17a25075-710f-447a-8c6c-1559767e03ad",
"installerEmail": "installer@75f.io",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
}
  • To fetch the OAO paired details and the pairing address:

Query

filter
"oao and equip and ahuRef==@ahuRef"

Example

filter
"oao and equip and ahuRef==@5ee3bd0ec601d557f8824869"

Result

{
"id": "r:5ee6eaadc601d557f8824bbf",
"ahuRef": "r:5ee3bd0ec601d557f8824869",
"dis": "madhu_06_12-OAO-1001",
"equip": "m:",
"floorRef": "r:SYSTEM",
"group": "1001",
"oao": "m:",
"profile": "OAO",
"roomRef": "r:SYSTEM",
"siteRef": "r:5ee3bcc9c601d557f8824858",
"tz": "Chicago"
}
  • To fetch the current value of the point using hisRead:

Query

id,range
@<pointRef>,"<timestamp>"

Example

id,range
@78de57d1-5888-471b-988f-0f8c8c4d5b56,"current"

Result

{
"ts": "t:2022-06-07T04:03:56.244Z",
"val": "n:79.8 °F"
}
  • To fetch equip details of particular node address using read:

Query

filter
"equip and group==@nodeAddress"

Example

filter
"equip and group==@1003"

Result

{
"id": "r:5ee7cfabc601d557f8826008",
"ahuRef": "r:5ee3bd0ec601d557f8824869",
"dab": "m:",
"dis": "madhu_06_12-DAB-1003",
"equip": "m:",
"floorRef": "r:5ee3bd0dc601d557f8824867",
"group": "1003",
"priorityLevel": "NORMAL",
"profile": "DAB",
"roomRef": "r:5ee7cfa2c601d557f8826006",
"siteRef": "r:5ee3bcc9c601d557f8824858",
"tz": "Chicago",
"zone": "m:"
},
{
"id": "r:5fbc09b17999d928544b0285",
"ahuRef": "r:5f2d998766768c4d06bba725",
"dis": "French's Mustard House-SSE-1003",
"equip": "m:",
"floorRef": "r:5f2450ee5ac89102e8715f45",
"group": "1003",
"priorityLevel": "NONE",
"profile": "SSE",
"roomRef": "r:5fbc096f7999d928544b0283",
"siteRef": "r:5f244ed95ac89102e8715f36",
"sse": "m:",
"tz": "Chicago",
"zone": "m:"
},
{
"id": "r:5fd3fa9d698ec307654cbbdc",
"ahuRef": "r:5f2d998766768c4d06bba725",
"dis": "French's Mustard House-SSE-1003",
"equip": "m:",
"floorRef": "r:5f2450ee5ac89102e8715f45",
"group": "1003",
"priorityLevel": "NONE",
"profile": "SSE",
"roomRef": "r:5fd3fa2e698ec307654cbbda",
"siteRef": "r:5f244ed95ac89102e8715f36",
"sse": "m:",
"tz": "Chicago",
"zone": "m:"
},
  • To fetch tuner equip point:

Query

filter
"tuner and equipRef==@euipRef"

Example

filter
"tuner and equipRef==@8e4c1a5d-78a6-42ba-b41f-2778976b5617"

Result

{
"id": "r:7f460bd2-6e1e-4e35-837c-138e8389e407",
"dis": "Product Home-hyperstatcpu-1100-unoccupiedZoneSetback",
"equipRef": "r:8e4c1a5d-78a6-42ba-b41f-2778976b5617",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"his": "m:",
"hisInterpolate": "cov",
"incrementVal": "n:1",
"kind": "Number",
"maxVal": "n:20",
"minVal": "n:0",
"point": "m:",
"roomRef": "r:2d7de6e1-1818-4ed0-b965-ed47a27bf9ca",
"setback": "m:",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"tuner": "m:",
"tunerGroup": "GENERIC",
"tz": "Colombo",
"unit": "°F",
"unoccupied": "m:",
"writable": "m:",
"zone": "m:"
},
{
"id": "r:647ece56-a9f8-4035-9ea2-637dc49f0827",
"dead": "m:",
"dis": "Product Home-hyperstatcpu-1100-zoneDeadTime",
"equipRef": "r:8e4c1a5d-78a6-42ba-b41f-2778976b5617",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"his": "m:",
"hisInterpolate": "cov",
"incrementVal": "n:1",
"kind": "Number",
"maxVal": "n:300",
"minVal": "n:1",
"point": "m:",
"roomRef": "r:2d7de6e1-1818-4ed0-b965-ed47a27bf9ca",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"time": "m:",
"tuner": "m:",
"tunerGroup": "TIMER",
"tz": "Colombo",
"unit": "m",
"writable": "m:",
"zone": "m:"
},
{
"id": "r:ad5ac3fa-9b7f-482b-bfa2-a5456016bef2",
"auto": "m:",
"away": "m:",
"dis": "Product Home-hyperstatcpu-1100-autoAwayTime",
"equipRef": "r:8e4c1a5d-78a6-42ba-b41f-2778976b5617",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"his": "m:",
"hisInterpolate": "cov",
"incrementVal": "n:1",
"kind": "Number",
"maxVal": "n:300",
"minVal": "n:0",
"point": "m:",
"roomRef": "r:2d7de6e1-1818-4ed0-b965-ed47a27bf9ca",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"time": "m:",
"tuner": "m:",
"tunerGroup": "TIMER",
"tz": "Colombo",
"unit": "m",
"writable": "m:",
"zone": "m:"
},
  • To fetch particular configuration point details using read:

Query

filter
"point and system and config and output and enabled and analog1 siteRef==@siteRef"

Example

filter
"point and system and config and output and enabled and analog1 
siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Result

{
"id": "r:5ef3560fd8b58821e1f56d9d",
"analog1": "m:",
"config": "m:",
"dis": "CCU4-SystemEquip-analog1OutputEnabled",
"enabled": "m:",
"enum": "false,true",
"equipRef": "r:5ef35607d8b58821e1f56cc6",
"floorRef": "r:SYSTEM",
"kind": "Number",
"output": "m:",
"point": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:5ef354a0d8b58821e1f56cb5",
"sp": "m:",
"system": "m:",
"tz": "Chicago",
"writable": "m:"
},
{
"id": "r:5efe55185356a51f3709eff9",
"analog1": "m:",
"config": "m:",
"dis": "McIntyre CCU-SystemEquip-analog1OutputEnabled",
"enabled": "m:",
"enum": "false,true",
"equipRef": "r:5efe55165356a51f3709eff3",
"floorRef": "r:SYSTEM",
"kind": "Number",
"output": "m:",
"point": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:5efe54cb5356a51f3709efe4",
"sp": "m:",
"system": "m:",
"tz": "Los_Angeles",
"writable": "m:"
},
{
"id": "r:5f57b06fca233125e328d668",
"analog1": "m:",
"config": "m:",
"dis": "Blount Home-SystemEquip-analog1OutputEnabled",
"enabled": "m:",
"enum": "false,true",
"equipRef": "r:5f57b05dca233125e328d50e",
"floorRef": "r:SYSTEM",
"kind": "Number",
"output": "m:",
"point": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:5f1717865ac89102e87155b9",
"sp": "m:",
"system": "m:",
"tz": "Chicago",
"writable": "m:"
},
  • To fetch priority value for desired heating temp using read:

To fetch the Tuner point

Query

filter
"point and temp and desired and heating and siteRef==@siteRef and group==@nodeaddress"

Example

filter
"point and temp and desired and heating and 
siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a and group==@1103"

Result

{
"id": "r:d660f82c-6c92-43a2-92a4-57d53656369d",
"air": "m:",
"bpos": "m:",
"desired": "m:",
"dis": "Product Home-BPOS-1103-desiredTempHeating",
"equipRef": "r:b2373bd6-b865-4724-b2d1-1e824203c6d6",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"group": "1103",
"heating": "m:",
"his": "m:",
"hisInterpolate": "cov",
"kind": "Number",
"point": "m:",
"roomRef": "r:dd4b4895-56f7-42c2-b0e6-1243240b4423",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"temp": "m:",
"tz": "Colombo",
"unit": "°F",
"userIntent": "m:",
"writable": "m:",
"zone": "m:"
}

To fetch the Tuner Value

Query

id,range
@Id,"<timestamp>"

Example

id,range
@5d62a307-008d-4fcc-a752-cb075fa3de35,"current"

Result

{
"ts": "t:2022-06-07T05:31:06.593Z",
"val": "n:65 °F"
}
  • To fetch priority value for desired cooling temp using read:

Query

filter
"point and temp and desired and cooling and siteRef==@siteRef and group==@nodeaddress"

Example

filter
"point and temp and desired and cooling and 
siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a and group==@1103"

Result

{
"id": "r:e725a620-fd90-4a73-815d-2be947aabdc1",
"air": "m:",
"bpos": "m:",
"cooling": "m:",
"desired": "m:",
"dis": "Product Home-BPOS-1103-desiredTempCooling",
"equipRef": "r:b2373bd6-b865-4724-b2d1-1e824203c6d6",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"group": "1103",
"his": "m:",
"hisInterpolate": "cov",
"kind": "Number",
"point": "m:",
"roomRef": "r:dd4b4895-56f7-42c2-b0e6-1243240b4423",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"temp": "m:",
"tz": "Colombo",
"unit": "°F",
"userIntent": "m:",
"writable": "m:",
"zone": "m:"
}

Follow the query for tuner value using hisRead option as below

Query

id,range
@Id,"<timestamp>"

Example

id,range
@e725a620-fd90-4a73-815d-2be947aabdc1,"current"

Result

{
"ts": "t:2022-06-07T05:31:06.593Z",
"val": "n:78 °F"
}
  • To fetch all the physical device details in the given site using read:

Query

filter
"device and
siteRef==@siteRef"

Example

filter
"device and siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Result

{
"id": "r:049276c4-ab74-4386-a14e-840ca922be4b",
"ahuRef": "r:b562dd75-2d0f-44a1-80c2-3efbe0201bea",
"ccu": "m:",
"createdDate": "d:2022-01-17",
"device": "m:",
"dis": "L1_CCU1",
"equipRef": "r:a2cf41fb-8047-47e3-a318-e5851d12107b",
"fmEmail": "rajat@75f.io",
"gatewayRef": "r:b562dd75-2d0f-44a1-80c2-3efbe0201bea",
"installerEmail": "installer@75f.io",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:83b70d78-6eb5-4ae3-ba12-736eaccc9de2",
"cm": "m:",
"device": "m:",
"dis": "CM-device",
"equipRef": "r:b562dd75-2d0f-44a1-80c2-3efbe0201bea",
"floorRef": "r:SYSTEM",
"his": "m:",
"network": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
{
"id": "r:707a2414-c840-40ae-92ce-e5f49d410863",
"addr": "2",
"device": "m:",
"dis": "EMR-2",
"emr": "m:",
"equipRef": "r:9f0cd37c-f728-4139-9983-2c795e84f78c",
"floorRef": "r:244d7dc0-8021-4108-ac7c-12c9e9d9021d",
"his": "m:",
"modbus": "m:",
"network": "m:",
"roomRef": "r:4d51391a-f7f4-4038-b697-b95b28a3cb07",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a"
},
  • To fetch recent his data for current temp point:

Query

filter
"point and air and temp and sensor and current and group==@1003 and siteRef==@siteRef"

Example

filter
"point and air and temp and sensor and current and group==@1103 and 
siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Result

{
"id": "r:fc587ecc-fa31-4d8e-859d-5420c7f6a39e",
"air": "m:",
"bpos": "m:",
"cur": "m:",
"current": "m:",
"dis": "Product Home-BPOS-1103-currentTemp",
"equipRef": "r:b2373bd6-b865-4724-b2d1-1e824203c6d6",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"group": "1103",
"his": "m:",
"hisInterpolate": "cov",
"kind": "Number",
"logical": "m:",
"point": "m:",
"roomRef": "r:dd4b4895-56f7-42c2-b0e6-1243240b4423",
"sensor": "m:",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"temp": "m:",
"tz": "Colombo",
"unit": "°F",
"zone": "m:"
}

Follow the query using the hisRead option as below for values

Query

id,range
@Id,"<timestamp>"

Example

id,range
@fc587ecc-fa31-4d8e-859d-5420c7f6a39e,"current"

Result

{
"ts": "t:2022-06-07T05:49:58.180Z",
"val": "n:81.6 °F"
}
  • To fetch recent his data for humidity sensor point:

Query

filter
"point and air and humidity and sensor and current and group==@1102 and
siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a"

Example

{
"id": "r:a59a5d5e-c44a-4e31-b2b8-cfeefaba7f6d",
"air": "m:",
"cur": "m:",
"current": "m:",
"dis": "Product Home-VAV-1102-humidity",
"equipRef": "r:510190c5-31c1-4eaf-986a-7e51861a6b0d",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"group": "1102",
"his": "m:",
"hisInterpolate": "cov",
"humidity": "m:",
"kind": "Number",
"logical": "m:",
"parallel": "m:",
"point": "m:",
"roomRef": "r:83923505-f159-40e2-bfa3-b364c9bedac7",
"sensor": "m:",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"tz": "Colombo",
"unit": "%",
"vav": "m:",
"zone": "m:"
}

Follow the query using the hisRead option as below for values

Query

id,range
@Id,"<timestamp>"

Example

id,range
@a59a5d5e-c44a-4e31-b2b8-cfeefaba7f6d,"current"

Result

{
"ts": "t:2022-06-07T06:02:51.160Z",
"val": "n:65.5 %"
}
  • To fetch all the dab equips using read equips option:

Query

filter
"equip and zone and dab"

Result

{
"id": "r:5ee3bd38c601d557f8824963",
"ahuRef": "r:5ee3bd0ec601d557f8824869",
"dab": "m:",
"dis": "madhu_06_12-DAB-1000",
"equip": "m:",
"floorRef": "r:5ee3bd0dc601d557f8824867",
"group": "1000",
"priorityLevel": "NORMAL",
"profile": "DAB",
"roomRef": "r:5ee3bd0dc601d557f8824868",
"siteRef": "r:5ee3bcc9c601d557f8824858",
"tz": "Chicago",
"zone": "m:"
},
{
"id": "r:5ee7cfabc601d557f8826008",
"ahuRef": "r:5ee3bd0ec601d557f8824869",
"dab": "m:",
"dis": "madhu_06_12-DAB-1003",
"equip": "m:",
"floorRef": "r:5ee3bd0dc601d557f8824867",
"group": "1003",
"priorityLevel": "NORMAL",
"profile": "DAB",
"roomRef": "r:5ee7cfa2c601d557f8826006",
"siteRef": "r:5ee3bcc9c601d557f8824858",
"tz": "Chicago",
"zone": "m:"
},
{
"id": "r:5ee7cfc3c601d557f8826053",
"ahuRef": "r:5ee3bd0ec601d557f8824869",
"dab": "m:",
"dis": "madhu_06_12-DAB-1004",
"equip": "m:",
"floorRef": "r:5ee3bd0dc601d557f8824867",
"group": "1004",
"priorityLevel": "NORMAL",
"profile": "DAB",
"roomRef": "r:5ee7cfb7c601d557f8826044",
"siteRef": "r:5ee3bcc9c601d557f8824858",
"tz": "Chicago",
"zone": "m:"
},
  • To fetch all the modbus equips using read equips option:

Query

filter
"equip and modbus"

Result

{
"id": "r:6070ffaac9ac7b20456194d9",
"dis": "The Basement 04092021-EMS-2",
"ems": "m:",
"equip": "m:",
"floorRef": "r:6070fe9cc9ac7b2045619322",
"gatewayRef": "r:6070fe83c9ac7b20456191d8",
"group": "2",
"modbus": "m:",
"model": "Multi Function Meters (iEM 3150)",
"profile": "MODBUS_EMS",
"roomRef": "r:6070feb8c9ac7b204561933e",
"siteRef": "r:6070fe13937f3259693e18df",
"tz": "Chicago",
"vendor": "Schneider",
"zone": "m:"
},
{
"id": "r:607943c3c9ac7b204561a75c",
"dis": "wetest-VRF-1",
"equip": "m:",
"floorRef": "r:607940a9c9ac7b204561a6e3",
"gatewayRef": "r:60793e3bc9ac7b204561a658",
"group": "1",
"modbus": "m:",
"model": "GW BMS01 02",
"profile": "MODBUS_VRF",
"roomRef": "r:60794391c9ac7b204561a75a",
"siteRef": "r:6079370b937f3259693e1a4d",
"tz": "Kolkata",
"vendor": "San TeleEquip",
"vrf": "m:",
"zone": "m:"
},
{
"id": "r:60794749c9ac7b204561a7d4",
"dis": "wetest-PAC-10",
"equip": "m:",
"floorRef": "r:607940a9c9ac7b204561a6e3",
"gatewayRef": "r:60793e3bc9ac7b204561a658",
"group": "10",
"modbus": "m:",
"model": "Flaktwood",
"pac": "m:",
"profile": "MODBUS_PAC",
"roomRef": "r:60794391c9ac7b204561a75a",
"siteRef": "r:6079370b937f3259693e1a4d",
"tz": "Kolkata",
"vendor": "Flaktwood",
"zone": "m:"
},
  • To fetch HyperStat equip entity details with particular node address using the read equips option:

Query

filter
"equip and HyperStat and group==@1100"

Result

{
"id": "r:9fa7f38b-37d5-42df-99ce-05c1f58ae4e8",
"cpu": "m:",
"dis": "Dev_CCU-hyperstatcpu-1100",
"equip": "m:",
"floorRef": "r:269e6442-7127-4624-9930-16d556086f5c",
"gatewayRef": "r:d9a1edb0-4799-430d-b74d-50831b06dfe1",
"group": "1100",
"HyperStat": "m:",
"priorityLevel": "NONE",
"profile": "HYPERSTAT_CONVENTIONAL_PACKAGE_UNIT",
"roomRef": "r:c9b782bc-f9e2-462c-aac5-818b6892d8da",
"siteRef": "r:8eba63c4-85a0-4e23-b5cc-9646bca65b50",
"tz": "Coral_Harbour",
"zone": "m:"
},
{
"id": "r:577fd034-fba2-41f7-8417-feeaec1e3dec",
"cpu": "m:",
"dis": "Thunderdome-hyperstatcpu-1100",
"equip": "m:",
"floorRef": "r:d1e7ac8b-4f0b-44f3-860c-8a9254e9f7a6",
"gatewayRef": "r:213a4c27-2420-4715-847b-babe18945071",
"group": "1100",
"HyperStat": "m:",
"priorityLevel": "NONE",
"profile": "HYPERSTAT_CONVENTIONAL_PACKAGE_UNIT",
"roomRef": "r:50ceb09a-b019-4c22-857a-d89772e8a487",
"siteRef": "r:527d9928-168c-4c9b-b1ad-9873b308a004",
"tz": "Chicago",
"zone": "m:"
},
{
"id": "r:c74e332a-7252-4b23-bcb4-0a765899e29e",
"cpu": "m:",
"dis": "SP CCU-hyperstatcpu-1100",
"equip": "m:",
"floorRef": "r:28fdaff9-8618-4813-8de5-293403ce70e9",
"gatewayRef": "r:9f1d9987-97b8-495d-ba7b-dd41d1fce5a8",
"group": "1100",
"HyperStat": "m:",
"priorityLevel": "NONE",
"profile": "HYPERSTAT_CONVENTIONAL_PACKAGE_UNIT",
"roomRef": "r:eadd9319-9083-4018-bd00-b8d4022b31e8",
"siteRef": "r:b7871af9-3e20-4da6-a545-266182cf8f26",
"tz": "Singapore",
"zone": "m:"
},
{
"id": "r:17d45913-ddc1-4821-9885-f820a053f92e",
"cpu": "m:",
"dis": "Rajat_Prod-hyperstatcpu-1100",
"equip": "m:",
"floorRef": "r:e45b509f-deef-46e7-a5e8-b7b162b35345",
"gatewayRef": "r:156ffb3e-8432-46fb-9b3d-08703da0f8d5",
"group": "1100",
"HyperStat": "m:",
"priorityLevel": "NONE",
"profile": "HYPERSTAT_CONVENTIONAL_PACKAGE_UNIT",
"roomRef": "r:f645350b-f9fb-4132-a346-7e1e7571c592",
"siteRef": "r:2da58793-3e61-4221-9d52-8602ba858ae8",
"standalone": "m:",
"tz": "Colombo",
"zone": "m:"
},
{
"id": "r:8e4c1a5d-78a6-42ba-b41f-2778976b5617",
"cpu": "m:",
"dis": "Product Home-hyperstatcpu-1100",
"equip": "m:",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"gatewayRef": "r:17a25075-710f-447a-8c6c-1559767e03ad",
"group": "1100",
"HyperStat": "m:",
"priorityLevel": "NONE",
"profile": "HYPERSTAT_CONVENTIONAL_PACKAGE_UNIT",
"roomRef": "r:2d7de6e1-1818-4ed0-b965-ed47a27bf9ca",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"tz": "Colombo",
"zone": "m:"
}
  • To fetch ccu entity details using the read equips option:

Query

filter
"device and ccu"

Result

{
"id": "r:5ee3bcfec601d557f8824866",
"ahuRef": "r:5ee3bd0ec601d557f8824869",
"ccu": "m:",
"createdDate": "d:2020-06-12",
"device": "m:",
"dis": "ccu_1_531",
"equipRef": "r:5ee3bd0ec601d557f882486a",
"fmEmail": "madhushan@75f.io",
"gatewayRef": "r:5ee3bd0ec601d557f8824869",
"installerEmail": "madhushan@75f.io",
"siteRef": "r:5ee3bcc9c601d557f8824858"
},
{
"id": "r:5ee3cbb4c601d557f88249c9",
"ahuRef": "r:5ee3cbcfc601d557f88249ca",
"ccu": "m:",
"createdDate": "d:2020-06-12",
"device": "m:",
"dis": "demo",
"equipRef": "r:5ee3cbcfc601d557f88249cb",
"fmEmail": "samjith@75f.io",
"gatewayRef": "r:5ee3cbcfc601d557f88249ca",
"installerEmail": "samjith@75f.io",
"siteRef": "r:5ee3cb82c601d557f88249bb"
},
{
"id": "r:5ee8ee84c601d557f8826319",
"ahuRef": "r:5eeaa3d2c601d557f882680c",
"ccu": "m:",
"createdDate": "d:2020-06-16",
"device": "m:",
"dis": "Video Studio",
"equipRef": "r:5ee8ee8dc601d557f882631d",
"fmEmail": "matt@75f.io",
"gatewayRef": "r:5eeaa3d2c601d557f882680c",
"installerEmail": "installer@75f.io",
"siteRef": "r:5ee8ee41c601d557f8826318"
},
{
"id": "r:5ee93139c601d557f88264de",
"ahuRef": "r:5ee93142c601d557f88264e1",
"ccu": "m:",
"createdDate": "d:2020-06-16",
"device": "m:",
"dis": "demo",
"equipRef": "r:5ee93142c601d557f88264e3",
"fmEmail": "samjith@75f.io",
"gatewayRef": "r:5ee93142c601d557f88264e1",
"installerEmail": "samjith@75f.io",
"siteRef": "r:5ee90b76c601d557f88264ce"
},
  • To fetch default value for the minimum humidity using read point option:

Query

filter
"config and humidity and min and group==@1000"

Result

{
"id": "r:d930a94a-abd8-42a0-aa8d-c9a96eb23988",
"config": "m:",
"dis": "SYS_VRV-Daikin VRV-1000-humiditySPMin",
"equipRef": "r:bf7a79ed-370c-4597-a0f0-10f26031fed2",
"floorRef": "r:f24a1526-e0f1-48d0-8de6-4a9681d3034e",
"group": "1000",
"humidity": "m:",
"kind": "Number",
"min": "m:",
"point": "m:",
"roomRef": "r:fe55a5f5-fe3b-4d83-9db6-d9fa7c94e305",
"siteRef": "r:5e36708a-58d4-4845-a946-ddef798cad84",
"sp": "m:",
"tz": "Kolkata",
"unit": "%",
"vrv": "m:",
"writable": "m:",
"zone": "m:"
},
{
"id": "r:a459d238-8d1f-4012-831b-0028f9468e72",
"config": "m:",
"dis": "FEB1_MS_TEST-Daikin VRV-1000-humiditySPMin",
"equipRef": "r:c97caf60-a018-43de-80f6-8105a06cca7d",
"floorRef": "r:af209784-5c11-4723-aea8-7fbeecb6f185",
"group": "1000",
"humidity": "m:",
"kind": "Number",
"min": "m:",
"point": "m:",
"roomRef": "r:8318b6a9-9e65-4c03-bb8e-676fea4e0dc5",
"siteRef": "r:6297ae1e-9c24-4b08-a2b9-d30d4f4c50b6",
"sp": "m:",
"tz": "Kolkata",
"unit": "%",
"vrv": "m:",
"writable": "m:",
"zone": "m:"
},
{
"id": "r:4b8ba33c-0309-49b3-aabe-02247390818a",
"config": "m:",
"dis": "TokenExp-Daikin VRV-1000-humiditySPMin",
"equipRef": "r:91693674-64f8-472f-84e5-12020df5206c",
"floorRef": "r:b7faae6e-7ff3-44d3-ae43-b65fa81cbefa",
"group": "1000",
"humidity": "m:",
"kind": "Number",
"min": "m:",
"point": "m:",
"roomRef": "r:9a3b2ba3-8f7e-49ad-9d52-39d2400bd945",
"siteRef": "r:6231abbd-7cc8-40de-bbb4-97f4a61075df",
"sp": "m:",
"tz": "Calcutta",
"unit": "%",
"vrv": "m:",
"writable": "m:",
"zone": "m:"
}
  • To fetch temperature offset value for a particular equip:

Query

filter
"point and temperature and offset and equipRef==@8e4c1a5d-78a6-42ba-b41f-2778976b5617"

Result

{
"id": "r:d5f378de-8f2d-46bb-a435-b6a17910f741",
"config": "m:",
"cpu": "m:",
"dis": "Product Home-hyperstatcpu-1100-temperatureOffset",
"equipRef": "r:8e4c1a5d-78a6-42ba-b41f-2778976b5617",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"group": "1100",
"HyperStat": "m:",
"kind": "Number",
"offset": "m:",
"point": "m:",
"roomRef": "r:2d7de6e1-1818-4ed0-b965-ed47a27bf9ca",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"temperature": "m:",
"tz": "Colombo",
"writable": "m:",
"zone": "m:"
}
  • To write his value for the point with a node address: 
    • For writing roomTemp:
hisWrite = "point and air and temp and sensor and current and group==@nodeAddr"
    • For writing humidity:
hisWrite ("point and air and humidity and sensor and current and group==@nodeAddr")
    • For writing co2:
hisWrite("point and air and co2 and sensor and current and group==@nodeAddr")
    • For writing voc:
hisWrite("point and air and voc and sensor and current and group==@nodeAddr")
  • To query for historized data reading through point id using hisread:

Query

id,range
@78de57d1-5888-471b-988f-0f8c8c4d5b56,"today"

Result

{
"ts": "t:2022-06-06T18:30:19.709Z",
"val": "n:81.2 °F"
},
{
"ts": "t:2022-06-06T18:32:19.788Z",
"val": "n:81.1 °F"
},
{
"ts": "t:2022-06-06T18:32:59.758Z",
"val": "n:81.2 °F"
},
{
"ts": "t:2022-06-06T18:33:39.797Z",
"val": "n:81.1 °F"
},
{
"ts": "t:2022-06-06T18:34:19.817Z",
"val": "n:81 °F"
},
{
"ts": "t:2022-06-06T18:34:59.835Z",
"val": "n:81.1 °F"
},
  • To query for historized data reading through point id using hisread:

Query

id,range
@78de57d1-5888-471b-988f-0f8c8c4d5b56,"yesterday"

Result

{
"ts": "t:2022-06-06T12:58:40.450Z",
"val": "n:0 °F"
},
{
"ts": "t:2022-06-06T12:58:50.229Z",
"val": "n:82.3 °F"
},
{
"ts": "t:2022-06-06T13:00:10.283Z",
"val": "n:82.4 °F"
},
{
"ts": "t:2022-06-06T13:00:50.228Z",
"val": "n:82.6 °F"
},
{
"ts": "t:2022-06-06T13:02:10.273Z",
"val": "n:82.7 °F"
},
{
"ts": "t:2022-06-06T13:03:30.311Z",
"val": "n:82.9 °F"
},
  • To query for historized data reading through point id using hisread:

Query

id,range
@78de57d1-5888-471b-988f-0f8c8c4d5b56,"current"

Result

{
"ts": "t:2022-06-07T06:38:01.901Z",
"val": "n:80.4 °F"
}
  • To write a point using the pointwrite

Query

id,level,val,who,duration
@<pointRef>,<level>,<value>,<who>,<duration>

Example

id,level,val,who,duration
@8d0e0629-7d27-40b3-a835-6e3553e33dd3,8,500,CCU,20

Result

{
"id": "r:8d0e0629-7d27-40b3-a835-6e3553e33dd3",
"duration": "n:0",
"level": "n:8",
"val": "n:500",
"who": "n:20"
},
{
"duration": "n:0",
"level": "n:17",
"val": "n:800",
"who": "ccu"
}

Confirmation visualized in the site explorer

Before:

mceclip1.png

After

mceclip2.png

  • To fetch current temp using READ query with equipRef and tags:

Query

filter
"current and temp and equipRef==@8e4c1a5d-78a6-42ba-b41f-2778976b5617"

Result

{
"id": "r:78de57d1-5888-471b-988f-0f8c8c4d5b56",
"air": "m:",
"cpu": "m:",
"cur": "m:",
"current": "m:",
"dis": "Product Home-hyperstatcpu-1100-currentTemp",
"equipRef": "r:8e4c1a5d-78a6-42ba-b41f-2778976b5617",
"floorRef": "r:aa40026c-b85d-4953-a512-216771a06110",
"group": "1100",
"his": "m:",
"hisInterpolate": "cov",
"HyperStat": "m:",
"kind": "Number",
"logical": "m:",
"point": "m:",
"roomRef": "r:2d7de6e1-1818-4ed0-b965-ed47a27bf9ca",
"sensor": "m:",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"temp": "m:",
"tz": "Colombo",
"unit": "°F",
"zone": "m:"
}
  • His read query with a date range using hisRead:

Query

ver:"2.0"
id,range
@5c7781c7-eb04-492c-904d-465baf1dadc9,"2022-06-06T00:00:00-05:00 
Kolkata 2022-06-06T23:59:59-05:00 Kolkata"

Result

{
"ts": "t:2022-06-06T12:58:40.450Z",
"val": "n:0 °F"
},
{
"ts": "t:2022-06-06T12:58:50.229Z",
"val": "n:82.3 °F"
},
{
"ts": "t:2022-06-06T13:00:10.283Z",
"val": "n:82.4 °F"
},
{
"ts": "t:2022-06-06T13:00:50.228Z",
"val": "n:82.6 °F"
},
{
"ts": "t:2022-06-06T13:02:10.273Z",
"val": "n:82.7 °F"
},
{
{
"ts": "t:2022-06-18T08:00:37.172Z",
"val": "n:0 °F"
},
{
"ts": "t:2022-06-18T08:01:29.848Z",
"val": "n:82.1 °F"
},
{
"ts": "t:2022-06-18T08:02:09.941Z",
"val": "n:82.2 °F"
},
{
"ts": "t:2022-06-18T08:02:49.950Z",
"val": "n:82.3 °F"
},
{
"ts": "t:2022-06-18T08:04:10.028Z",
"val": "n:82.4 °F"
},
{
"ts": "t:2022-06-18T08:04:50.172Z",
"val": "n:82.3 °F"
},
{
"ts": "t:2022-06-18T08:08:10.415Z",
"val": "n:82.2 °F"
},
{
"ts": "t:2022-06-18T08:10:10.596Z",
"val": "n:82.1 °F"
},
{
"ts": "t:2022-06-18T08:12:10.795Z",
"val": "n:82 °F"
},
{
"ts": "t:2022-06-18T08:16:03.011Z",
"val": "n:82 °F"
},
{
"ts": "t:2022-06-18T08:16:11.163Z",
"val": "n:81.9 °F"
},
"ts": "t:2022-06-06T13:03:30.311Z", "val": "n:82.9 °F" }, { "ts": "t:2022-06-06T13:04:10.704Z", "val": "n:82.8 °F" }, { "ts": "t:2022-06-06T13:04:50.375Z", "val": "n:82.9 °F" }, { "ts": "t:2022-06-06T13:05:30.393Z", "val": "n:82.8 °F" }, { "ts": "t:2022-06-06T13:06:50.388Z", "val": "n:82.7 °F" }, { "ts": "t:2022-06-06T13:13:30.610Z", "val": "n:82.6 °F" }, { "ts": "t:2022-06-06T13:14:10.610Z", "val": "n:82.5 °F" }, { "ts": "t:2022-06-06T13:15:30.676Z", "val": "n:82.4 °F" }, { "ts": "t:2022-06-06T13:16:10.643Z", "val": "n:82.5 °F" }, { "ts": "t:2022-06-06T13:16:50.687Z", "val": "n:82.4 °F" }, { "ts": "t:2022-06-06T13:17:30.688Z", "val": "n:82.3 °F" }, { "ts": "t:2022-06-06T13:18:10.707Z", "val": "n:82.4 °F" }, { "ts": "t:2022-06-06T13:18:50.723Z", "val": "n:82.3 °F" }, { "ts": "t:2022-06-06T13:22:10.827Z", "val": "n:82.2 °F" }, { "ts": "t:2022-06-06T13:24:50.924Z", "val": "n:82.1 °F" }, { "ts": "t:2022-06-06T13:25:30.916Z", "val": "n:82.2 °F" }, { "ts": "t:2022-06-06T13:27:30.977Z", "val": "n:82.1 °F" }, { "ts": "t:2022-06-06T13:28:11.010Z", "val": "n:82.2 °F" }, { "ts": "t:2022-06-06T13:28:50.989Z", "val": "n:82 °F" },
  • To query all points under a Site but limit it to 1000 using read API:

Query

filter,limit
"point and siteRef==@f14645d9-7e54-46d1-9e23-3924c83a599a,1000"

Result

{
"id": "r:523d6448-5021-4962-afc0-9e0446e111db",
"cooling": "m:",
"deadband": "m:",
"default": "m:",
"dis": "Product Home-BuildingTuner-DualDuct-coolingDeadbandMultiplier",
"dualDuct": "m:",
"equipRef": "r:1d324c1c-7624-4d38-b9fa-6fe940afa430",
"floorRef": "r:SYSTEM",
"his": "m:",
"hisInterpolate": "cov",
"incrementVal": "n:0.1",
"kind": "Number",
"maxVal": "n:5",
"minVal": "n:0.5",
"multiplier": "m:",
"point": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"tuner": "m:",
"tunerGroup": "DAB",
"tz": "Colombo",
"writable": "m:"
},
{
"id": "r:c4197429-93c6-462d-85e0-ca5a8d17d8e7",
"airflow": "m:",
"cooling": "m:",
"default": "m:",
"dis": "Product Home-BuildingTuner-stage4CoolingAirflowTempLowerOffset",
"equipRef": "r:1d324c1c-7624-4d38-b9fa-6fe940afa430",
"floorRef": "r:SYSTEM",
"his": "m:",
"hisInterpolate": "cov",
"incrementVal": "n:1",
"kind": "Number",
"lower": "m:",
"maxVal": "n:0",
"minVal": "n:-150",
"offset": "m:",
"point": "m:",
"roomRef": "r:SYSTEM",
"siteRef": "r:f14645d9-7e54-46d1-9e23-3924c83a599a",
"sp": "m:",
"stage4": "m:",
"temp": "m:",
"tuner": "m:",
"tunerGroup": "ALERT",
"tz": "Colombo",
"unit": "°F",
"writable": "m:"
},

| Sample Custom Queries in PAM and Heatmap Visualizations

In not just Developer tools, you can also build complex queries in the Global visualization space in the Heat map and PAM Dashboards using just the Tags, operators and parentheses as follows.

Note: The FILTER function is invalid in these visualizations.

Using the inbuilt query sets in the PAM and Heatmap visualizations, the user can filter and plot only one set of data at a time.

With the use of complex queries using the Tags, operators and parentheses, the user can filter and plot multiple sets of data at a time in a single visualization.

Below are a few examples. 

Examples 1:

The below query fetches everything in the systems settings page in the portal using read API

The below section provides all the configuration parameters for a profile and its associated options that the user has set:

system and point and config and enabled and output and sp
and (relay1 or relay2 or relay3 or realy4 orrelay5 or relay6 or relay7)
or (analog1 or analog2 or analog3) or analog4) 
and (equipRef==@7843c881-bcc5-442a-8124-a35c92056783
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783 
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783 
or equipRef==@f26bf796-b9f6-45fe-94d4-a0bf824dbca1
or equipRef==@f26bf796-b9f6-45fe-94d4-a0bf824dbca1 
or equipRef==@f26bf796-b9f6-45fe-94d4-a0bf824dbca1
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783 
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783 
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783)
or system and point and config and association and output and sp
and (relay1 or relay2 or relay3 or realy4 or relay5 or relay6 or relay7)
and (equipRef==@1e91c03d-640b-46b2-ad28-2d00ffd158bf 
or equipRef==@355fdc83-7faa-41eb-84b7-8ca0dd5f84aa
or equipRef==@419150ff-1193-432e-9a8d-19cfdadc7895 
or equipRef==@68a965e1-7206-4985-a418-689fea2e621d
or equipRef==@f26bf796-b9f6-45fe-94d4-a0bf824dbca1 
or equipRef==@f26bf796-b9f6-45fe-94d4-a0bf824dbca1
or equipRef==@f26bf796-b9f6-45fe-94d4-a0bf824dbca1 
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783 
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783
or equipRef==@7843c881-bcc5-442a-8124-a35c92056783)

Query Filter in Global Visualization in Heatmap:

mceclip5.png

Examples 2:

The below query allows us to get all diagnostic points of a system:

diag and cloud and connectivity 
and (equipRef==@d0a46b33-d477-496e-8d41-5fd479b77074 
or equipRef==@2ddb9998-7311-467b-a4eb-6373c0915140 
or equipRef==@8c89ed37-e668-4669-b93e-19e78e206dca)

Query Filter in Global Visualization in Heatmap:

mceclip3.png

Examples 3:

The below query allows us to get all epidemic mode user intent setting points of a system

system and userIntent and 
(prePurge or postPurge or ventilation) 
and enabled and (equipRef==@b0383da9-1817-4f45-b9c4-7f63f6841620 
or equipRef==@b562dd75-2d0f-44a1-80c2-3efbe0201bea 
or equipRef==@419150ff-1193-432e-9a8d-19cfdadc7895)

Query Filter Global Visualization in Heatmap:

mceclip0.png

Query Filter in PAM:

mceclip1.png

Examples 4:

The below complex query can be formed by combining all the above points also.

system and userIntent and mode and conditioning 
and equipRef==@b0383da9-1817-4f45-b9c4-7f63f6841620
or diag and cloud and connectivity 
and equipRef==@2ddb9998-7311-467b-a4eb-6373c0915140
or system and userIntent and ci and desired 
and equipRef==@355fdc83-7faa-41eb-84b7-8ca0dd5f84aa
or system and userIntent and demand and response
and equipRef==@419150ff-1193-432e-9a8d-19cfdadc7895
or system and target and humidity and (min or max) 
and (equipRef==@1e91c03d-640b-46b2-ad28-2d00ffd158bf 
or equipRef==@68a965e1-7206-4985-a418-689fea2e621d)
or system and point and config and association and output and sp 
and (relay1 or relay2 or relay3 or relay4 or relay5 or relay6 or relay7) 
and (equipRef==@1e91c03d-640b-46b2-ad28-2d00ffd158bf 
or equipRef==@355fdc83-7faa-41eb-84b7-8ca0dd5f84aa 
or equipRef==@419150ff-1193-432e-9a8d-19cfdadc7895)
or system and config and (heating or cooling) and enabled 
and (equipRef==@b0383da9-1817-4f45-b9c4-7f63f6841620 
or equipRef==@b562dd75-2d0f-44a1-80c2-3efbe0201bea 
or equipRef==@355fdc83-7faa-41eb-84b7-8ca0dd5f84aa 
or equipRef==@419150ff-1193-432e-9a8d-19cfdadc7895)
or system and point and config and humidifier and sp and relay7 
and equipRef==@b562dd75-2d0f-44a1-80c2-3efbe0201bea
or heartbeat and (equipRef==@9f0cd37c-f728-4139-9983-2c795e84f78c 
or equipRef==@cc6de852-d8d6-4f27-9599-53b727f24d01 
or equipRef==@837b698c-9f3a-4582-9481-7949cf2be133)
or system and userIntent and (prePurge or postPurge or ventilation) 
and enabled and (equipRef==@b0383da9-1817-4f45-b9c4-7f63f6841620 
or equipRef==@b562dd75-2d0f-44a1-80c2-3efbe0201bea 
or equipRef==@419150ff-1193-432e-9a8d-19cfdadc7895)

Below is a Tried out examples in:

Query Filter in PAM:

mceclip7.png

Query Filter in Global Visualization in Heatmap:

mceclip6.png

Note: The query strings are not just case sensitive, but they are quiet sensitive, any change to the syntax or format, like additional space or missed out space or comma (,) or apostrophe ("), and or case change to lower or upper in the query string, any of it could hamper the results queried for, or there is no result at all.

 

Previous
Next

Comments

0 comments

Please sign in to leave a comment.

Was this article helpful?

0 out of 0 found this helpful
Powered by Zendesk