acronameDevices Endpoint¶

The acronameDevices endpoint enumerates all of the attached Acroname devices on the host system, and provides information about their connection parameters, software licenses, and module information.

There are no input parameters to this endpoint. It will return a JSON array of devices, or error, encapsulated in a transaction envelope.

JSON Schema for Response Object¶

The following tables list a JSON Schema for the response object.

Download the raw JSON Schema file for this response: acroname_devices_response.json

Object Fields of Acroname Devices Response¶

Name	Type	Mandatory	Description
`acronameDevices`	Array<Object>	Yes	An array containing all Acroname devices in the system.

Object Fields of `acronameDevices[]`¶

Name	Type	Mandatory	Description
`type`	v1-type	Yes	Type of connection to device
`serialNumber`	v1-serialNumber	Yes	Acroname Serial Number
`module`	v1-uint32	Yes	Brainstem Module address of this device
`router`	v1-uint32	No	BrainStem network router address
`routerSerialNumber`	v1-serialNumber	No	BrainStem network router serial number
`model`	v1-model	Yes	Model Number of device (see aDefs.c for allowed values)
`entitlements`	Array<Object>	No	An array containing all entitlements for this specific device

Object Fields of `acronameDevices[].entitlements[]`¶

Name	Type	Mandatory	Description
`tag`	v1-tag	Yes	The entitlement tag associated with this entitlement
`version`	v1-uint32	Yes	Version field of the specified entitlement

v1-type¶

Name	Value
Type	string
description	Enumeration of all possible USB speeds
Enumerations	`INVALID`, `USB`, `TCPIP`, `SERIAL`, `NETWORK`

v1-uint32¶

Name	Value
Type	integer
description	Unsigned 32-bit integer
minimum	0
maximum	4294967295

v1-serialNumber¶

Name	Value
Type	string
description	Representation of an Acroname device serial number
Regular Expression	`^(0x)?[A-Fa-f0-9]{8}$`

v1-tag¶

Name	Value
Type	string
description	Representation of the entitlement tag

v1-model¶

Name	Value
Type	string
description	Enumeration of all supported Acroname devices.
Enumerations	`USBStem`, `EtherStem`, `MTMIOSerial`, `MTMPM1`, `MTMEtherStem`, `MTMUSBStem`, `USBHub2x4`, `MTMRelay`, `USBHub3p`, `MTMDAQ1`, `USBCSwitch`, `MTMDAQ2`, `MTMLoad1`, `USBHub3c`, `Unknown`

Examples¶

curl http://127.0.0.1:9005/api/v1/acronameDevices

import requests
import json
response = requests.get('http://127.0.0.1:9005/api/v1/acronameDevices')
json_data = response.json()
print(json.dumps(json_data, indent=4))

The output will be similar to the following:

{
    "timestamp": "2023-09-20T17:11:54.092Z",
    "request": {
        "endpointName": "/api/v1/acronameDevices",
        "parameters": {}
    },
    "response": {
        "acronameDevices": [
            {
                "type": "USB",
                "serialNumber": "3C43352C",
                "module": 6,
                "model": "USBHub3c",
                "entitlements": [
                    {
                        "tag": "CONTROL",
                        "version": 0
                    }
                ]
            },
            {
                "type": "USB",
                "serialNumber": "F7D9AFB6",
                "module": 6,
                "model": "USBHub3p",
                "entitlements": [
                    {
                        "tag": "CONTROL",
                        "version": 0
                    }
                ]
            }
        ]
    }
}