ikalogic-scanastudio

Python SDK for ScanaStudio v6, the software behind Ikalogic logic analysers and pattern generators.

ScanaStudio runs a server that owns the devices and speaks one WebSocket protocol. The interface is a client of that protocol, and so is this package — so everything you can do in the application, you can do from a script: capture, decode, measure, generate patterns and export.

pip install ikalogic-scanastudio

Capture and decode

from ikalogic_scanastudio import ScanaStudio, Trigger

with ScanaStudio.connect() as server:
    workspace = server.create("se254")  # a demo device: no hardware needed

    workspace.capture.run(
        samples=1_000_000,
        sample_rate=25_000_000,
        trigger=Trigger.rising(channel=0, position=0.1),
    )

    i2c = workspace.decoders.add(
        "i2c.js",
        {"ch_scl": workspace.channel("I2C SCL"), "ch_sda": workspace.channel("I2C SDA")},
        wait=True,
    )
    for packet in i2c.packets():
        print(f"{workspace.capture.seconds(packet.start):.6f}s  {packet.title}: {packet.content}")

    workspace.export_csv("packets.csv", source="packets", instances=[i2c.instance_id])

server.create takes a demo key such as se254, or hw:<serial> for real hardware; server.devices() lists both. server.open takes the path of a .scana instead, and server.attach joins a workspace already running.

⚠️ A demo device generates pseudo-random noise, not protocol traffic. It runs the whole path — capture, decode, measure, export — which is what makes it useful for writing and testing a script without hardware, but a decoder run on it finds structure by chance.

Read the raw signal

for edge in workspace.data.transitions(channel=0):
    print(edge.sample, edge.level)

The iterator pages for you, however long the capture. The first edge it yields is the level in force where you started reading, so a window describes itself.

Find out what a decoder takes

for option in workspace.decoders.options("i2c.js"):
    print(option)
# ch_sda: SDA Channel (ch_selector) = None
# address_format [Advanced options]: Address display format (combo)
#     one of ['HEX', 'Binary', 'Decimal'] = 'HEX'

Pass those by id or by caption, as Python values — a channel number, a combo entry by name, a flag as True. Anything left out keeps the script's default.

Leave a capture running

The server owns the workspace, so disconnecting destroys nothing. Start a long acquisition, go away, and come back to it:

with ScanaStudio.connect() as server:
    workspace = server.create("hw:SP259-000123")
    workspace.capture.start(samples=2_000_000_000)
    print("running as workspace", workspace.id)

# later, from anywhere
with ScanaStudio.connect("ws://bench.local:4911") as server:
    for session in server.workspaces():
        print(session.workspace_id, session.device_name, session.state)
    workspace = server.attach(session.workspace_id)
    workspace.capture.wait()

⚠️ A server listening beyond loopback has no authentication: whoever reaches the port has the devices.

What is where

Versions

This SDK speaks protocol 8. ScanaStudio.connect refuses a server that speaks another, since a mismatch means one of the two needs updating. The protocol itself is documented in api/schema/protocol.md.

MIT licensed.