Quick Start¶

Creating a Client¶

The main entry point is AccordionQ2Client. Pass the base URL of the AccordionQ2 WebApi:

from accordionq2 import AccordionQ2Client

client = AccordionQ2Client("http://agent64.local:5000")

Constructor Parameters¶

Parameter	Type	Default	Description
`base_url`	`str`	—	Base URL of the AccordionQ2 WebApi, e.g. `"http://raspberrypi:5000"`
`timeout`	`float`	`30.0`	HTTP request timeout in seconds
`auth`	`tuple[str, str] \\| None`	`None`	Optional `(username, password)` for HTTP Basic Auth
`verify`	`bool \\| str`	`True`	TLS certificate verification. `False` disables (useful for self-signed certs on embedded devices). A string is treated as a path to a CA bundle file.
`default_headers`	`dict[str, str] \\| None`	`None`	Additional headers merged into every request (e.g. `{"X-Api-Key": "secret"}`)

Using a Context Manager¶

The recommended approach is to use a with block:

with AccordionQ2Client("http://agent64.local:5000") as client:
    names = client.resources.get_names()
    print(names)

The client also works without a context manager:

client = AccordionQ2Client("http://agent64.local:5000")
names = client.resources.get_names()
client.close()

Authentication and TLS¶

# HTTP Basic Auth
with AccordionQ2Client("https://device.local:5001", auth=("admin", "secret")) as client:
    names = client.resources.get_names()

# Self-signed certificate — disable TLS verification
with AccordionQ2Client("https://device.local:5001", verify=False) as client:
    names = client.resources.get_names()

# Custom header (e.g. API key)
with AccordionQ2Client("http://device.local:5000",
                       default_headers={"X-Api-Key": "my-key"}) as client:
    names = client.resources.get_names()

Checking the Connection¶

with AccordionQ2Client("http://agent64.local:5000") as client:
    status = client.connection.get_status()
    if status.is_connected:
        print("Connected to hardware manager")
    else:
        print("Not connected:", status.last_error)

Reading and Writing Values¶

Resources are identified by dotted name strings (e.g. "TempRegulator.CPU_TEMP"):

# Read a single value
temp = client.resources.get_value("TempRegulator.CPU_TEMP")
print(f"CPU temperature: {temp}")

# Read multiple values at once
values = client.resources.get_values([
    "TempRegulator.CPU_TEMP",
    "Engine.Uptime",
])
for name, val in values.items():
    print(f"{name} = {val}")

# Write a value
client.resources.set_value("MyOutput", "2.5")

Working with Channels¶

# List all channels
for ch in client.channels.get_all():
    print(f"  {ch.alias}: type={ch.channel_type}, unit={ch.unit}")

# Look up a specific channel
ch = client.channels.get_channel(alias="0.1.ESH10000158.MON_3V3")
print(f"Type: {ch.channel_type}, Direction: {ch.direction}")

Configuring a Channel¶

Use partial updates — only the fields you set are changed:

from accordionq2.models import ChannelConfigRequest

client.channels.configure(ChannelConfigRequest(
    alias="0.1.ESH10000158.MON_3V3",
    description="Main 3.3 V rail monitor",
    unit="V",
))

Handling Errors¶

All API errors raise AccordionQ2ApiError:

from accordionq2 import AccordionQ2ApiError

try:
    ch = client.channels.get_channel(alias="does.not.exist")
except AccordionQ2ApiError as e:
    print(f"HTTP {e.status_code}: {e}")

Next Steps¶

Explore the full API Reference for detailed documentation of all 8 operation groups.