Comm — Raw Bus Transactions

Perform raw bus transactions over I2C, UART, SPI, and TCP sockets. All byte data is hex-encoded on the wire (e.g. "AABB" for bytes 0xAA 0xBB).

Methods

All methods return a BusTransactionResponse:

I2C

Use I2cTransactionRequest:

Examples

using AccordionQ2.WebApiClient.Models;

// Scan the bus for connected devices
var resp = await client.Comm.I2cAsync(new I2cTransactionRequest
{
    DeviceName = "0.ESH10000597.I2C00",
    Address    = "00",
    Action     = BusActions.Scan,
});
Console.WriteLine($"Scan result: {resp.Received}");

// Write two bytes to address 0x50
await client.Comm.I2cAsync(new I2cTransactionRequest
{
    DeviceName = "0.ESH10000597.I2C00",
    Address    = "50",
    Action     = BusActions.Send,
    DataToSend = "0010",
});

// Read 4 bytes from address 0x50
var read = await client.Comm.I2cAsync(new I2cTransactionRequest
{
    DeviceName              = "0.ESH10000597.I2C00",
    Address                 = "50",
    Action                  = BusActions.Receive,
    NumberOfBytesToReceive  = 4,
});
Console.WriteLine($"Read: {read.Received}"); // e.g. "AABBCCDD"

// Write then read (SendReceive)
var xfer = await client.Comm.I2cAsync(new I2cTransactionRequest
{
    DeviceName             = "0.ESH10000597.I2C00",
    Address                = "50",
    Action                 = BusActions.SendReceive,
    DataToSend             = "00",
    NumberOfBytesToReceive = 2,
});

UART

Use UartTransactionRequest:

Example

// Send a SCPI query at 115200 baud and read the response
// "*IDN?\n" in hex is "2A49444E3F0A"
var resp = await client.Comm.UartAsync(new UartTransactionRequest
{
    DeviceName             = "MyUartDevice",
    PortName               = "/dev/ttyS0",
    BaudRate               = 115200,
    BusType                = UartBusTypes.RS232,
    FlowControl            = FlowControlTypes.None,
    Parity                 = ParityTypes.None,
    Action                 = BusActions.SendReceive,
    DataToSend             = "2A49444E3F0A",
    NumberOfBytesToReceive = 64,
    TimeoutMs              = 2000,
});
var text = System.Text.Encoding.ASCII.GetString(
    Convert.FromHexString(resp.Received));
Console.WriteLine(text);

SPI

Use SpiTransactionRequest:

Example

// Full-duplex SPI transfer
var resp = await client.Comm.SpiAsync(new SpiTransactionRequest
{
    DeviceName             = "MySpiDevice",
    Action                 = BusActions.SendReceive,
    DataToSend             = "AABB",
    NumberOfBytesToReceive = 2,
});
Console.WriteLine($"SPI response: {resp.Received}");

Socket (TCP/IP)

Use SocketTransactionRequest:

Example

// Send a SCPI query over TCP
// "*IDN?\n" in hex is "2A49444E3F0A"
var resp = await client.Comm.SocketAsync(new SocketTransactionRequest
{
    DeviceName             = "MySocketDevice",
    Action                 = BusActions.SendReceive,
    HostName               = "192.168.1.10",
    Port                   = 5025,
    DataToSend             = "2A49444E3F0A",
    NumberOfBytesToReceive = 64,
});
var text = System.Text.Encoding.ASCII.GetString(
    Convert.FromHexString(resp.Received));
Console.WriteLine(text);

Hex Encoding Note

All DataToSend strings and the Received field use uppercase hex without separators, e.g. "AABB0C". You can use Convert.FromHexString / Convert.ToHexString (.NET 5+) or a manual loop on older runtimes to convert between byte[] and hex strings.