sdlab

command module

v0.0.0-...-b191741 Latest Latest Go to latest Published: Nov 9, 2016 License: GPL-3.0 Imports: 26 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/scratchduino/sdlab

Links

Open Source Insights

README ¶

sdlab

SDLab backend service application. Used for getting data from sensors and monitoring with saving detections to database. Provide special API for frontend socket/tcp requests.

SDLab application uses different types of databases:

RRD database (until v1.5)
SQLite database (v1.5+)

Use sensors config files from sdlab-sensors project (https://github.com/robboworld/sdlab-sensors).

Build

Use Go 1.4+. Tested on Debian 7 (wheezy), Debian 8 (jessie), Ubuntu/Linaro 14.04.

Additional packages:

Golang: robboworld/i2c, pborman/uuid, gopkg.in/yaml.v1
Golang: mattn/go-sqlite3 (only for SQLite version)
Golang: ziutek/rrd (only for RRD version)
rrdtool, librrd-dev (only for RRD version)

Steps:

Get sdlab sources.

# mkdir -p ~/go/src
# cd ~/go/src
# git clone https://github.com/robboworld/sdlab.git

Prepare environment.

$ export GOPATH="/home/user/go"
$ export CGO_ENABLED=1

Prepare sources and packages (sdlab/user, i2c, uuid, ( rrd | sqlite ), yaml.

$ cd ~/go
$ mkdir -p src/github.com/robboworld/sdlab
$ cp -r src/sdlab/user src/github.com/robboworld/sdlab/

$ go get github.com/robboworld/i2c

$#go get code.google.com/p/go-uuid   # old, this project has been moved:
$ go get github.com/pborman/uuid

$ go get gopkg.in/yaml.v1

Database related packages:

(only for RRD version)

# apt-get install rrdtool
# apt-get install librrd-dev

$ go get github.com/ziutek/rrd

(only for SQLite version)
```
$ go get github.com/mattn/go-sqlite3
```

Build go application.

$ cd ~/go/src/sdlab
$ go build -a -v

#Check hidden warnings and possible errors
$ go tool vet ./
$ go tool vet -shadow ./
$ go tool vet -shadow -shadowstrict ./

Config

Application config: sdlab.conf (yaml file format). Config file location:

/etc/sdlab/sdlab.conf (default)

OR

Use full path from first command line argument, example sdlab /home/user/sdlab.conf

See config file example: debian/sdlab.conf

Install

Prepare application config:

# mkdir /etc/sdlab/
# mkdir /etc/sdlab/sensors.d/
# cp debian/sdlab.conf /etc/sdlab/
# chmod 644 /etc/sdlab/sdlab.conf
# chown root:root /etc/sdlab/sdlab.conf

Edit config (set i2c buses, buffers length, sensors configs path, database path and etc):

# nano /etc/sdlab/sdlab.conf

Prepare logs:
```
# touch /var/log/sdlab.log
```
Prepare databases.
- (only for RRD version) Prepare dirs for RRD monitoring:
```
# mkdir -p /var/lib/sdlab/monitor/
```
- (only for SQLite version):
```
# mkdir -p /var/lib/sdlab/monitor/
```

Install.

Install application:

# cp ~/go/src/sdlab/sdlab /usr/sbin/sdlab
# chown root:root /usr/sbin/sdlab
# chmod 755 /usr/sbin/sdlab

Install application as service and check pathes in init file:

# cp ~/go/src/sdlab/debian/sdlab.init /etc/init.d/sdlab
# nano /etc/init.d/sdlab
# chown root:root /etc/init.d/sdlab
# chmod 755 /etc/init.d/sdlab
# update-rc.d sdlab defaults

Install additional scripts.

Install timezone update scripts:

# cp ~/go/src/sdlab/changetz.sh /usr/local/bin/changetz.sh
# cp ~/go/src/sdlab/sdlabreboot.sh /usr/local/bin/sdlabreboot.sh
# chown root:staff /usr/local/bin/changetz.sh
# chown root:root /usr/local/bin/changetz.sh /usr/local/bin/sdlabreboot.sh
# chmod 755 /usr/local/bin/changetz.sh /usr/local/bin/sdlabreboot.sh

Install webcams maintenance scripts. Prerequisites: mjpg-streamer (use https://github.com/alodos/mjpg-streamer.git fork of https://github.com/jacksonliam/mjpg-streamer.git )

# cp ~/go/src/sdlab/mjpgcmdline.sh /usr/local/bin/mjpgcmdline.sh
# cp ~/go/src/sdlab/camlist.sh /usr/local/bin/camlist.sh
# chown root:root /usr/local/bin/mjpgcmdline.sh /usr/local/bin/camlist.sh
# chmod 755 /usr/local/bin/mjpgcmdline.sh /usr/local/bin/camlist.sh

Run

Run as service (start|stop|restart|status).

    # service sdlab stop
    # service sdlab start

JSON RPC SDLab backend API

Testing write requests and receive responses with socket connection using socat:

$ sudo socat UNIX:/var/run/sdlab.sock -

JSON Request format:

    {"jsonrpc":"2.0","method":"Lab.METHOD","params":[PARAMS],"id":0}

where:

jsonrpc - request type/version,
method - called method (ex. Lab.METHOD),
params - method arguments (object, array, string and etc.) or empty (empty array),
id - request id.

JSON Response format:

    {"id":0,"result":RESULT,"error":ERROR}

where:

id - request id,
result - returned results (array, object, string, boolean and etc.),
error - string with error description if returned, if no error empty (null).

Methods. Simple data API

Lab.GetData Read data from single sensor, get single value. Params:

object with sensor-value info:
- Sensor - sensor identifier,
- ValueIdx - value index.

Returns:

object with data or empty on error:
- Time - time in RFC3339 format with TZ and nanoseconds,
- Reading - value(ints, floats and etc.) at this Time.

Request:

{"jsonrpc":"2.0","method":"Lab.GetData","params":[{"Sensor":"bmp085-1:77","ValueIdx":1}],"id":0}

Response:

{"id":0,"result":{"Time":"2016-08-25T13:18:58.925888913+03:00","Reading":299.65},"error":null}

Response (error):

{"id":0,"result":null,"error":"Cannot read file '/sys/bus/i2c/devices/i2c-1/1-0077/temp0_input': read /sys/bus/i2c/devices/i2c-1/1-0077/temp0_input: communication error on send"}

Lab.ListSensors Get list of registered sensors, rescan sensors if needed. Params:

bool True to rescan sensors for find new connected and purge disconnected (False by default)

Returns:

object with sensors info by keys named as sensor identifiers, each sensor have array of Values or empty on error:
- Values - array of sensor values objects:
  - Name - string, value name
  - Range - object with available detection range
    - Min
    - Max
  - Resolution - int, max detection step in nanoseconds

Request:

{"jsonrpc":"2.0","method":"Lab.ListSensors","params":[true],"id":0}

Response:

{"id":0,"result":{
    "bh1750fvi-1:23":{"Values":[
        {"Name":"illuminance","Range":{"Min":0,"Max":65535},"Resolution":200000000}]},
    "bmp085-1:77":{"Values":[
        {"Name":"pressure","Range":{"Min":30000,"Max":110000},"Resolution":30000000},
        {"Name":"temperature","Range":{"Min":233.15,"Max":358.15},"Resolution":5000000}]},
    "rotenccont-1:4":{"Values":[
        {"Name":"angle","Range":{"Min":0,"Max":6.283185307},"Resolution":50000000}]}},"error":null}

Methods. Series API

Lab.StartSeries Start series detections, store detections data in process memory, identified by uuid, Maximum detections buffer capacity is specified in application config file. Maximum simultaneously series count (pool length) is specified in config file also. Params:
- object with Values list of objects
Returns:
- string uuid on success, null on error (max available series in pool, unknown sensor and etc.)
Example - series length = 3, 1 sensor, 1 value, period = 1 sec. Request:
```
{"jsonrpc":"2.0","method":"Lab.StartSeries","params":[{"Values":[{"Sensor":"bmp085-1:77","ValueIdx":0}
    ],"Period":1000000000,"Count":3}],"id":0}
```
Response:
```
{"id":0,"result":"835047db-3d85-4a50-8d9e-4f9fc23dd2ac","error":null}
```
Example - series length = 10, 1 sensor, 2 values, period = 15 sec: Request:
```
{"jsonrpc":"2.0","method":"Lab.StartSeries","params":[{"Values":[{"Sensor":"bmp085-1:77","ValueIdx":0},{"Sensor":"bmp085-1:77","ValueIdx":1}
    ],"Period":15000000000,"Count":10}],"id":0}
```
Response:
```
{"id":0,"result":"115047db-3d85-4a23-8d9e-4f9fcc3dd2ac","error":null}
```

Lab.StopSeries Stop series detection by uuid. Params:

string series uuid

Returns:

bool true success, false or null on error

Request:

{"jsonrpc":"2.0","method":"Lab.StopSeries","params":["ec9a44d7-11e6-4b6a-af6c-897f7884f985"],"id":0}

Response:

{"id":0,"result":true,"error":null}

Lab.GetSeries Get series detection by uuid. For running and already stopped series also. Carefully, detections data is pushed out from memory buffer. Params:

string series uuid

Returns:

array array of objects with data or empty on error:
- Time - time in RFC3339 format with TZ and nanoseconds,
- Readings - array of values(ints, floats and etc.) at this Time.

Request:

{"jsonrpc":"2.0","method":"Lab.GetSeries","params":["ec9a44d7-11e6-4b6a-af6c-897f7884f985"],"id":0}

Response:

{"id":0,"result":[
    {"Time":"2016-08-15T13:38:00.31759214+03:00","Readings":[100284,298.54999999999995]},
    {"Time":"2016-08-15T13:38:15.317576023+03:00","Readings":[100281,298.54999999999995]},
    ...
    {"Time":"2016-08-15T13:40:00.317610447+03:00","Readings":[100283,298.65]},
    {"Time":"2016-08-15T13:40:15.317576872+03:00","Readings":[100288,298.65]}],"error":null}

Lab.ListSeries Get list of registered series detection (runned and stopped). Returns:
- array array of objects with data or empty on error:
  - UUID - string series id,
  - Stop - bool, true if stopped by request, else false,
  - Finished - bool, true if finished (made requested detections count), else false.
  - Len - int, number of finished detections, may be larger than buffer length (older data is pushed out)
Request:
```
{"jsonrpc":"2.0","method":"Lab.ListSeries","params":[],"id":0}
```
Response:
```
{"id":0,"result":[
    {"UUID":"835047db-3d85-4a50-8d9e-4f9fc23dd2ac","Stop":false,"Finished":true,"Len":3},
    {"UUID":"1bfe4c62-7e91-45b3-8313-12a28d2e3f4c","Stop":false,"Finished":false,"Len":2}],"error":null}
```
Lab.StopSeries Stop series detection by uuid. Params:
- string series uuid
Returns:
- bool true on success, false or null on error (if stopped already or not exists and etc.)
Request:
```
{"jsonrpc":"2.0","method":"Lab.StopSeries","params":["ec9a44d7-11e6-4b6a-af6c-897f7884f985"],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Lab.RemoveSeries Remove series detection by uuid from memory pool. Release pool for new series. Params:
- string series uuid
Returns:
- bool true on success, false or null on error (if not exists and etc.)
Request:
```
{"jsonrpc":"2.0","method":"Lab.RemoveSeries","params":["fa20547a-71ba-4f24-9c72-93b0bf3ebbc8"],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Lab.CleanSeries Remove ALL series detection from memory pool. Release pool for new series. Returns:
- bool true on success, false or null on error
Request:
```
{"jsonrpc":"2.0","method":"Lab.CleanSeries","params":[],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```

Methods. Monitoring API

Lab.StartMonitor Start long monitoring with storing data to external storage as RRD, or SQL-liked database. Database type and parameters is specified in application config file. Two stop conditions supported:
- stop by detections count, if set Count > 0,
- stop by time, if StopAt is not zero time (00001-01-01T00:00:00Z - January 1, year 1, 00:00:00.000000000 UTC), if zero time - run infinite or until reached Count or until stop command sended.
Parameter Duration is not used as stop condition, just must set to cache in monitor info, 0 if not used. Please calculate StopAt for stop by time condition. Params:
- object with monitoring parameters (see examples)
Returns:
- string uuid on success, null on error (unknown sensor and etc.)
Example - monitor for experiment = 1, sensors setup = 1, detections count = 0, step = 5sec, duration = 100sec, stop at 2016-08-16T14:50:00Z, 1 sensor, 1 value. Request:
```
{"jsonrpc":"2.0","method":"Lab.StartMonitor","params":[
    {"Exp_id":1,"Setup_id":1,"Step":5,"Count":0,"Duration":100,"StopAt":"2016-08-16T14:50:00Z","Values":[
        {"Sensor":"bmp085-1:77","ValueIdx":0}]
    }],"id":0}
```
Response:
```
{"id":0,"result":"835047db-3d85-4a50-8d9e-4f9fc23dd2ac","error":null}
```
Example - monitor for experiment = 1, sensors setup = 1, detections count = 20, step = 1sec, no stop at, 1 sensor, 2 values. Request:
```
{"jsonrpc":"2.0","method":"Lab.StartMonitor","params":[
    {"Exp_id":1,"Setup_id":1,"Step":1,"Count":20,"Duration":20,"StopAt":"00001-01-01T00:00:00Z","Values":[
        {"Sensor":"bmp085-1:77","ValueIdx":0},
        {"Sensor":"bmp085-1:77","ValueIdx":1}]
    }],"id":0}
```
Response:
```
{"id":0,"result":"857e2ec6-1099-4879-aa06-0f65a24dad2c","error":null}
```

Lab.StopMonitor Stop monitor by uuid. Params:

string monitor uuid

Returns:

bool true success, false or null on error

Request:

{"jsonrpc":"2.0","method":"Lab.StopMonitor","params":["857e2ec6-1099-4879-aa06-0f65a24dad2c"],"id":0}

Response:

{"id":0,"result":true,"error":null}

Lab.ListMonitors Get list of monitoring processes (runned and stopped). Returns:

array array of objects with data or empty on error:
- Active - bool, true if monitoring is active, else false,
- UUID - string monitor uuid,
- Created - string, creation time in RFC3339 format with TZ and nanoseconds,
- StopAt - string, stop at restriction time in RFC3339 format with TZ and nanoseconds,
- Values - array of objects with sensor values info:
  - Name - sensor name,
  - Sensor - sensor identifier,
  - ValueIdx - value index.

Request:

{"jsonrpc":"2.0","method":"Lab.ListMonitors","params":[],"id":0}

Response:

{"id":0,"result":[
    {"Active":false,"UUID":"857e2ec6-1099-4879-aa06-0f65a24dad2c","Created":"2016-08-17T16:18:24.258780114+03:00", "StopAt":"2016-08-17T13:25:00Z",
     "Values":[
        {"Name":"pressure0","Sensor":"bmp085-1:77","ValueIdx":0},
        {"Name":"temperature1","Sensor":"bmp085-1:77","ValueIdx":1}]},
    {"Active":false,"UUID":"ac19da70-85bc-4b0f-8513-5b97d2cadb27","Created":"2016-08-16T21:21:28.426346079+03:00","StopAt":"2016-08-16T18:22:00Z",
     "Values":[
        {"Name":"pressure0","Sensor":"bmp085-1:77","ValueIdx":0}]},
    {"Active":false,"UUID":"b26d1988-b6b5-4b6d-80a6-01bc43e53aab","Created":"2016-08-16T21:21:33.534725373+03:00","StopAt":"2016-08-16T18:25:00Z",
     "Values":[
        {"Name":"pressure0","Sensor":"bmp085-1:77","ValueIdx":0},
        {"Name":"temperature1","Sensor":"bmp085-1:77","ValueIdx":1}]}
    ],"error":null}

Lab.GetMonInfo Get monitoring process info by uuid. Params:
- string monitor uuid
Returns:
- object with data or empty on error:
  - Active - bool, true if monitoring is active, else false,
  - Created - string, creation time in RFC3339 format with TZ and nanoseconds,
  - StopAt - string, "stop at" time restriction in RFC3339 format with TZ and nanoseconds,
  - Last - string, last detection time in RFC3339 format with TZ and nanoseconds,
  - Amount - uint, stop at count condition (0 if not used),
  - Duration - uint, monitoring duration cached in monitor (0 if not used),
  - Counters - object with currect counters (Done - all done detectios, Err - failed detections from all)
  - Archives - array of objects (Step, Len) with data storing steps info, if storage support returned multiple steps (as Step x 1, Step x 4, Step x 16, end etc., in seconds), default only one Step x 1, returned also Len of data strobes already saved by each Step,
  - Values - array of objects with sensor values info:
    - Name - sensor name,
    - Sensor - sensor identifier,
    - ValueIdx - value index,
    - Len - detections made by this sensor and value (by default Step)
Request:
```
{"jsonrpc":"2.0","method":"Lab.GetMonInfo","params":["857e2ec6-1099-4879-aa06-0f65a24dad2c"],"id":0}
```
Response:
```
{"id":0,"result":
    {"Active":false,"Created":"2016-08-17T16:18:24.258780114+03:00","StopAt":"2016-08-17T13:25:00Z","Last":"2016-08-17T16:21:14.305Z",
     "Amount":20,"Duration":444, 
     "Counters":{"Done":170,"Err":4},
     "Archives":[{"Step":1,"Len":170}],
     "Values":[
         {"Name":"pressure0","Sensor":"bmp085-1:77","ValueIdx":0,"Len":170},
         {"Name":"temperature1","Sensor":"bmp085-1:77","ValueIdx":1,"Len":170}]
    },"error":null}
```
Lab.RemoveMonitor Remove monitoring by uuid from memory and storage register at all. If WithData is true also removes all detections data made by this monitoring. Params:
- object
  - UUID string,
  - WithData bool, False by default
Returns:
- bool true on success, false or null on error (if not exists and etc.)
Request:
```
{"jsonrpc":"2.0","method":"Lab.RemoveMonitor","params":[{"UUID":"857e2ec6-1099-4879-aa06-0f65a24dad2c","WithData":true}],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Lab.StrobeMonitor Create one strobe of detections for monitoring and update database immediately. Can be used by exists monitoring if specified UUID, or standalone for custom sensors and values set. Params:
- object
  - UUID string, monitor UUID if use exists monitor sensors configuration (than Opts, OptsStrict may be omitted),
  - Opts object with monitoring info and sensors setup, MUST BE used if empty UUID, else ignored:
    - Exp_id int - experiment id,
    - Setup_id int - setup id (NOT USED),
    - Step int - (NOT USED),
    - Count int - number of detections, always 1 (NOT USED),
    - Duration int - duration, always 0 (NOT USED),
    - StopAt int - time (NOT USED, but MUST be not null, can be zero time = 0001-01-01T00:00:00Z),
    - Values - array of objects with sensor values info:
      - Sensor - sensor identifier,
      - ValueIdx - value index,
  - OptsStrict bool, true to check if sensors and values exists and valid, false to skip checking and save NaN values on sensor error, CAN BE used with Opts, default False.
Returns:
- bool true on success, false or null on error (if not exists monitor or sensors error in strict mode and etc.)
Request:
```
{"jsonrpc":"2.0","method":"Lab.StrobeMonitor","params":[{"UUID":"3358c035-6e58-4a78-bb5b-7a6e6c2b2d67"}],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Request:
```
{"jsonrpc":"2.0","method":"Lab.StrobeMonitor","params":[
    {"UUID":"","Opts":{"Exp_id":2,"Setup_id":2,"Step":1,"Count":1,"Duration":0,"StopAt":"0001-01-01T00:00:00Z",
     "Values":[{"Sensor":"bmp085-1:77","ValueIdx":0},{"Sensor":"bmp085-1:77","ValueIdx":1}]}
    }],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Request:
```
{"jsonrpc":"2.0","method":"Lab.StrobeMonitor","params":[
    {"UUID":"","Opts":{"Exp_id":2,"Setup_id":2,"Step":1,"Count":1,"Duration":0,"StopAt":"2016-08-16T14:50:00Z",
     "Values":[{"Sensor":"bmp085-1:77","ValueIdx":0},{"Sensor":"bmp085-1:77","ValueIdx":1}],
     "OptsStrict":true}
    }],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```

Lab.GetMonData Get monitoring data by UUID and time range. May be specified only additionally Start and/or Stop time for range of data. Step is used only if storage is support multiplicative Steps storing data, must by specified.+ Params:

object
- UUID - string,
- Start - string, FROM time in RFC3339 format with TZ and nanoseconds (optional),
- End - string, TO time in RFC3339 format with TZ and nanoseconds (optional),
- Step - bool (must be specified, not used, for future use).

Returns:

array array of objects with data or empty on error:
- Time - time in RFC3339 format with TZ and nanoseconds,
- Readings - array of values(ints, floats and etc.) at this Time.

Request:

{"jsonrpc":"2.0","method":"Lab.GetMonData","params":[
    {"UUID":"b26d1988-b6b5-4b6d-80a6-01bc43e53aab","Start":"2016-08-16T21:22:50.000Z","End":"2016-08-16T21:23:00.000Z","Step":5000000000}],"id":0}

Response:

{"id":0,"result":[
    {"Time":"2016-08-16T21:22:59.574Z","Readings":[100139,296.65]},
    {"Time":"2016-08-16T21:23:00.574Z","Readings":[100136,296.65]}
    ],"error":null}

Request:

{"jsonrpc":"2.0","method":"Lab.GetMonData","params":[
    {"UUID":"857e2ec6-1099-4879-aa06-0f65a24dad2c","Step":5000000000}],"id":0}

Response:

{"id":0,"result":[
    {"Time":"2016-08-17T16:59:29.407Z","Readings":[100741,299.45]},
    {"Time":"2016-08-17T16:59:34.407Z","Readings":[100740,299.45]},
    ...
    {"Time":"2016-08-17T16:59:54.407Z","Readings":[100742,299.34999999999997]},
    {"Time":"2016-08-17T16:59:59.407Z","Readings":[100735,299.34999999999997]}
    ],"error":null}

Methods. Time API

Lab.SetDatetime Set system date, time and timezone. Params:
- object
  - TZ - string, text name or timezone, empty string if use current timezone,
  - Datetime - string, datetime in RFC3339 format with TZ and nanoseconds,
  - Reboot - bool, True to reboot, device MUST BE rebooted if changed timezone (set to True).
Returns:
- bool true on success, false or null on error
Request:
```
{"jsonrpc":"2.0","method":"Lab.SetDatetime","params":[{"TZ":"","Datetime":"2016-08-16T21:23:00.000Z","Reboot":false}],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```

Methods. Video cameras API

Lab.ListVideos Get list of connected web camera devices. Returns:
- array array of objects with data or empty on error:
  - Index - uint, device index from device path (ex, 1).
  - Device - full device name (ex, "/dev/video1"),
  - Name - device name from video4linux
Request:
```
{"jsonrpc":"2.0","method":"Lab.ListVideos","params":[],"id":0}
```
Response:
```
{"id":0,"result":[
    {"Index":1,"Device":"/dev/video1","Name":"Creative Webcam"},
    {"Index":2,"Device":"/dev/video2","Name":"Noname webcam"}
    ],"error":null}
```
Lab.GetVideoStream Get video stream info from video stream service on server. Params:
- string, device name (ex., "/dev/video0") Returns:
- object with stream info or empty on error:
  - Index - uint, device index from device path (ex, 1).
  - Device - full device name (ex, "/dev/video1"),
  - Stream - uint, stream index in streamer (ex, 0).
  - Port - port images stream, default 8090. (example of full path: http://127.0.0.1:8090?action=snapshot_{Stream}&n={RandomNum})
Request:
```
{"jsonrpc":"2.0","method":"Lab.GetVideoStream","params":[],"id":0}
```
Response:
```
{"id":0,"result":{"Index":1,"Device":"/dev/video1","Stream":0,"Port":8090},"error":null}
```
Lab.StartVideoStream Start/On video/image streaming on device. Params:
- string, device name (ex., "/dev/video0")
Returns:
- bool true on success, false or null on error
Request:
```
{"jsonrpc":"2.0","method":"Lab.StartVideoStream","params":["/dev/video0"],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Lab.StopVideoStream Stop/Off video/image streaming on device. Params:
- string, device name (ex., "/dev/video0")
Returns:
- bool true on success, false or null on error
Request:
```
{"jsonrpc":"2.0","method":"Lab.StopVideoStream","params":["/dev/video0"],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Lab.StartVideoStreamAll Start/On video/image streaming on all connected web camera devices. Returns:
- bool true on success, false or null on error
Request:
```
{"jsonrpc":"2.0","method":"Lab.StartVideoStreamAll","params":[],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```
Lab.StopVideoStreamAll Stop/Off video/image streaming on all connected web camera devices. Returns:
- bool true on success, false or null on error
Request:
```
{"jsonrpc":"2.0","method":"Lab.StopVideoStreamAll","params":[],"id":0}
```
Response:
```
{"id":0,"result":true,"error":null}
```

Errors examples

Error request format Request:

{}

Response:

    {"id":null,"result":null,"error":"rpc: service/method request ill-formed: "}

Unknown method error Request:

    {"jsonrpc":"2.0","method":"Lab.METHOD","params":[],"id":0}

Response:

    {"id":0,"result":null,"error":"rpc: can't find method Lab.METHOD"}

Documentation ¶

Rendered for

There is no documentation for this package.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
user

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

sdlab

Table of Contents

Build

Config

Install

Run

JSON RPC SDLab backend API

Methods. Simple data API

Methods. Series API

Methods. Monitoring API

Methods. Time API

Methods. Video cameras API

Errors examples

Documentation ¶

Source Files ¶

Directories ¶