cbrx_apidetails
Returns an enhanced version of the details of the API. This information can also be gained by passing an optional true parameter to cbrx_apiversion.
Syntax: see API Call Structure
|
{ "method": "cbrx_apidetails" } |
Returns:
|
{ "result": { "version": [version-number], "semver": "semver-variant", "commitid": commitid-number, "branch": "branch-name", "capability": [API-capability], "notifications": [possible-notification], "install": "install-location", "logging": "logs-location", "settings": "settings-location", "documentation": "documentation-location", "cpu": { "brand": "brand-information", "arch": "CPU-architecture", "features": [CPU-features], "cores": cores-value }, "os": "OS-information" } } |
| Output | Description |
|---|---|
| version-number | Version number of API as an integer (Major,Minor,Revision,Build) |
| semver-variant | The full name of the API version |
| commitid-variant | The number value of the Commit ID |
| branch-name | The branch of API installed |
| API-capability | available with version of API |
| possible-notification | Array of strings to show possible notification. see API Notifications |
| install-location | The location of install files |
| logs-location | The location of where logs are stored |
| settings-location | The location of API settings |
| documentation-location | The web address of API documentation |
| brand-information | The brand of the CPU |
| CPU-architecture | The architecture of the CPU |
| CPU-features | Features available on CPU |
| cores-value | How many cores the CPU has |
| os-information | Operating system running on local machine |
Examples
Example JSON-RPC request:
{
"jsonrpc": "2.0",
"id": 0,
"method": "cbrx_apidetails"
}Example Successful response
{
"jsonrpc": "2.0",
"id": 0,
"result": {
"version": [
3,
7,
0,
34
],
"semver": "3.7.0+34",
"guid": {
"id": "d0dc3cac-e165-4e38-88bb-39064431bdc9",
"computerId": "35aea4bc-44d3-4e9e-9b3c-c33b965c5639"
},
"host": [
{
"ip": "10.167.111.81",
"port": 0,
"nameServer": "10.167.111.241",
"domainName": "CBRX.LOCAL",
"hostName": "CBRXPC-011",
"adapterName": "Intel(R) Ethernet Controller (3) I225-V",
"adapterType": "Ethernet"
}
],
"commitid": 4287981321,
"branch": "release",
"capability": [
"protobuf",
"crash-report",
"notification"
],
"notifications": [
"usb-changed",
"usb-device-attached",
"usb-device-detached",
"discover-changed",
"dead-hub-changed",
"firmware-progress",
"rfid-received",
"rfid-removed",
"over-temperature",
"over-voltage",
"under-voltage",
"certificate-changed"
],
"install": "C:\\Program Files\\Cambrionix\\API",
"logging": "C:\\ProgramData\\Cambrionix\\Log",
"settings": "C:\\ProgramData\\Cambrionix",
"documentation": "C:\\Program Files\\Cambrionix\\API\\Product Name Reference.html",
"cpu": {
"brand": "12th Gen Intel(R) Core(TM) i9-12900K",
"arch": "x64",
"features": [
"aes",
"avx",
"avx2",
"bmi1",
"bmi2",
"clflushopt",
"clfsh",
"clwb",
"cx16",
"cx8",
"erms",
"f16c",
"fma3",
"fpu",
"mmx",
"movbe",
"pclmulqdq",
"popcnt",
"rdrnd",
"rdseed",
"sha",
"smx",
"ss",
"sse",
"sse2",
"sse3",
"sse4_1",
"sse4_2",
"ssse3",
"tsc",
"vaes",
"vpclmulqdq"
],
"cores": 24
},
"os": "Windows 10 Pro 21H2 Build 19044.1889 64-bit"
}
}