IoTQL - an SQL-like language for the IoT.
Note that we're likely going to depreciate all of this except for the CREATE MODEL call. Why? Because it's starting to look like Apache Drill may be a better solution.
IoTQL is an SQL-like language for the IoT. It allows you to query Things, change their state, and define actions to happen in the future. It also allows you to write Models for Things.
Here's a few example queries - see below and the docs folder for a lot more:
-- see everything
SELECT id, state:*, meta:*;
-- set the temperature in the basement
SET state:temperature = 20°C WHERE meta:zone & "Basement";
-- set the color of Hue lights
SET state:color = "#FF9999" WHERE meta:model-id = "hue-light";
It's written to work with HomeStar / IOTDB but is flexible enough to plug into almost any projects that can present a simple Transporter API.
Then:
$ npm install -g homestar ## may require sudo
$ homestar install iotql
Basic pattern:
$ homestar iotql
IoTQL ships with a (very small) data set for testing
$ homestar iotql --samples
>>> SELECT id, meta:*;
Make sure you've installed and set up HomeStar, and are in the proper folder - usually your home directory. Then just do:
$ homestar iotql
All Models in IOTDB are now written using IoTQL. These Models are compiled to JSON-LD for actual usage. You can see examples here:
To embed IoTQL in your projects, do:
$ homestar install iotql
You can use npm instead of homestar if you're not
using HomeStar.
See the docs folder for more documentation. There's also a ton of examples in samples.
Here's how you use IoTQL in your project
var iotql = require('iotql')
var paramd = {};
iotql.connect(paramd, function(error, db) {
);
Not implemented yet
var transporter = ...;
transport.list({
query: "state:sensor.temperature°C > 25",
}, function(d) {
if (d.query) {
}
});
Transporters do not need to support queries.
Transporters that do support query will always set d.query
to true when a query statement is used.
SELECT id, meta:*, meta:*;
SET state:on = true
SET state:color = "yellow" WHERE meta:facet & facets.lighting;
SET state:temperature = 20°C WHERE meta:zone & "Basement"
SELECT units(state:sensor.temperature, °F)
or (more flexible, but unwieldy)
SELECT units(state:sensor.temperature,
units:temperature.imperial.fahrenheit)
This isn't quite finished yet, but you can do
$ node tools/RunSamples --all
The samples are in samples. The Things it
runs against are in samples/things.
How that's structured should be fairly obvious.
$ node tools/RunSamples --all --write
$ node tools/RunSamples --all --test
This can also be done by
$ npm test
to compile the grammar, you need to do this
$ ( cd ./grammar; jison grammar.jison )