Quick Start Guide¶

To get started with BrainD, follow these steps:

Install BrainD following the Installation Guide.
Connect an Acroname product with a valid Software License installed. For this guide, a USBHub3c will be used, with serial number F7A9DFC6.
Start BrainD by selecting it in the Start Menu under “Acroname” (Windows) or from the Applications directory (Mac). An icon will appear in the system taskbar.
The BrainD service is now running. The RESTful API is available at http://127.0.0.1:9005. See the following sections for example usage. Additional examples are in the documentation for each RESTful endpoint.

GET Example - Get Version¶

The version of software that is running can be read by issuing a GET request to the version endpoint.

curl -H 'Accept: application/json' http://127.0.0.1:9005/api/v1/version

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

The resulting return of the version will return the following JSON body.

{
    "braind": {
        "version": {
            "major": 1,
            "minor": 0,
            "patch": 0
        },
        "buildDate": "Thu Aug 24 13:58:24 2023",
        "buildHash": "d38f0a1dd5f8daa2c8cd0a0170fee8210d1356b4"
    },
    "brainstem": {
        "version": {
            "major": 2,
            "minor": 10,
            "patch": 0
        },
        "buildDate": "2023-09-08T19:03:10Z",
        "buildHash": "7af9c07e44601d6987fe3dab0ea201a13609683e"
    }
}

PUT Example - Set BrainStem Port Off¶

BrainD is designed to manage and manipulate Acroname products through the RESTful API

curl -X PUT http://127.0.0.1:9005/api/v1/brainstem/F7A9DFC6/port/1/enabled -H 'Content-Type: application/json' -d '{"value": 0}'

import requests
import json
response = requests.put('http://127.0.0.1:9005/api/v1/brainstem/F7A9DFC6/port/1/enabled', json={'value': 0})
json_data = response.json()
print(json.dumps(json_data, indent=3))

The resulting return of the version will return the following JSON body.

{
    "timestamp": "2023-09-18T04:43:09.813Z",
    "request": {
        "endpointName": "/api/v1/brainstem/F7A9DFC6/port/1/enabled",
        "parameters": {
            "value": 0
        }
    },
    "response": {}
}

GET Example - Get BrainStem Port 2 Vbus Voltage¶

curl http://127.0.0.1:9005/api/v1/brainstem/F7A9DFC6/port/2/VbusVoltage

import requests
import json
response = requests.put('http://127.0.0.1:9005/api/v1/brainstem/F7A9DFC6/port/2/VbusVoltage')
json_data = response.json()
print(json.dumps(json_data, indent=3))

{
    "timestamp": "2023-09-18T04:56:16.639Z",
    "request": {
        "endpointName": "/api/v1/brainstem/F7A9DFC6/port/2/VbusVoltage",
        "parameters": {}
    },
    "response": {
        "value": 5100097,
        "rawValue": 5100097
    }
}