Settings§
The following document represents a brief guide on Settings resource. SENSR settings consists of 4 categories of configurations. (and +1 special category) If you want to access a specific configuration, you need to first access the corresponding resource. Each category (resource) are described below.
Supported Methods§
- GET
- POST
- PUT /node category only
- DELETE /node category only
Resources§
-
/settings/app§
This resource is mapped to app configuration. App configuration has configs related to application setup. (e.g. path of starting project)
Parameters§
- config-id : Id of the desired config
Return code§
- 200 OK
- 400 BAD REQ
- config-id : Id of the desired config
-
/settings/project§
This resource is mapped to project configuration. Project configuration has configs related to a project setting. (e.g. master node ip address, input mode.)
Parameters§
- config-id : Id of the desired config
Return code§
- 200 OK
- 400 BAD REQ
- config-id : Id of the desired config
-
/settings/algorithm§
This resource is mapped to algorithm configuration. Algorithm configuration has configs related to perception algorithm. Configs here will affect results of SENSR significantly.
Parameters§
- config-id : Id of the desired config
- node-type : (
algoormaster) Type of node which the desired config is located. Most algorithm configs are located underalgonode. But if you runs multi algo nodes, the integration of algorithm results are occurred atmasternode. You can change integration related configs here. - node-uri : IP address of algo node which the desired config is located. (If you use one algo node it is normally
localhost.)
Return code§
- 200 OK
- 400 BAD REQ
-
/settings/sensor§
This resource is mapped to sensor configuration. Sensor configuration has configs related to connected sensors. Configs here will affect the gathering part of raw point cloud.
Parameters§
- config-id : Id of the desired config
- node-uri : IP address of algo node which the desired config is located. (If you use one algo node it is normally
localhost.)
Return code§
- 200 OK
- 400 BAD REQ
-
/settings/node§
This is a special resource to control algo node. You can add/delete/modify an algo node using this.
Parameters§
- node-uri : IP address of the desired algo node. (If you use one algo node it is normally
localhost.)
Return code§
- 200 OK
- 400 BAD REQ
- node-uri : IP address of the desired algo node. (If you use one algo node it is normally
Special Resource§
-
/list§
You can put
/listin the above resources. This resource will return a type of config as json.e.g.) localhost:9080/settings/algorithm/list?
Parameters§
- config-id : Id of the desired config. If you put empty,
/listwill return all configs type in resources configuration. - node-type : If your resources is algorithm, you need to select type of node.
- node-uri : IP address of algo node which the desired config is located. (If you use one algo node it is normally
localhost.)
Return code§
- 200 OK
- 400 BAD REQ
An example§
$ curl -X GET http://localhost:9080/settings/algorithm/list?config-id=parameters.detection&node-type=algo&node-uri=localhost { "resolution" : "Floating" "min_point_count" : "Integer" "x_range" : "Vector2" "y_range" : "Vector2" "z_range" : "Vector2" "negative_x_range" : "Vector2" "negative_y_range" : "Vector2"}Here is a list of the types that SENSR API supports natively:
- Int
- Bool
- Float
- String
- Offset Datetime
- Local Datetime
- Local Time
- Vector2 (2 Float array)
- Vector3 (3 Float array)
- Vector4 (4 Float array)
- Array[type]
- An homogeneous array of one single type.
- Array[Table]
- Array can have table type too. In this case, returned json format will be array which has one table inside.
- Table
- A simple type table that supports either nested tables, arrays or simple types. In this case, returned json format will be table.
- A simple type table that supports either nested tables, arrays or simple types. In this case, returned json format will be table.
- config-id : Id of the desired config. If you put empty,