pyrokid_cxr_clientm

com.rokid.cxr.client-m library for Python

A python port of the com.rokid.cxr.client-m Java library.

The idea is to allow you to use the CXR-M SDK on any device with bluetooth.

class pyrokid_cxr_clientm.CXRSocketProtocol

Bases: object

com.rokid.cxr.client.CXRSocketProtocol Java class in Python

class Callback

Bases: ABC

com.rokid.cxr.client.CXRSocketProtocol.Callback Interface - Please extend this class and implement the methods!

abstractmethod onARTCFrame(data: bytes) → None

abstractmethod onAudioStream(i: int, data: bytes, offset: int, size: int) → None

abstractmethod onAudioStreamFinish(codec: int) → None

abstractmethod onDisconnect() → None

abstractmethod onNotify(cmd: str, args: Caps) → None

abstractmethod onReceived(cmd: str, args: Caps, stream: bytes) → None

abstractmethod onResponse(reqId: int, args: Caps) → None

abstractmethod onStartAudioStream(i: int, codec: int, cmd: str, args: Caps) → None

a: str

mTag

b = None

c = None

d = None

e: Callable = None

f: int = 0

g: bool = False

h: bool = False

i: Callback = None

mCallback

j: int

size?

version() → int

class pyrokid_cxr_clientm.Caps(values: list[Value] = None)

Bases: object

Main Caps container class for serialization/deserialization

Parameters:

values (Optional[list[Caps.Value]]) – Optional values list, in case you already have a list of Caps.Value’s. Else its recommended to use Caps.fromBytes()

CAPS_VERSION = 5

Current Caps version.

exception CapsError

Bases: Exception

Base exception for Caps operations

exception IncorrectTypeException

Bases: RuntimeError

Exception that throws when Type of a Caps.Value is not what you were expecting

class Value(vType: chr = None, value: Any = None)

Bases: object

Represents a single value in Caps format

TYPE_BINARY = 66

TYPE_DOUBLE = 100

TYPE_FLOAT = 102

TYPE_INT32 = 105

TYPE_INT64 = 108

TYPE_OBJECT = 79

TYPE_STRING = 83

TYPE_UINT32 = 117

TYPE_UINT64 = 107

TYPE_VOID = 86

getBinary() → bytes

Validate if value is bytes/BINARY and return it

getDouble() → float

Validate if value is float/DOUBLE and return it

getFloat() → float

Validate if value is float/FLOAT and return it

getInt() → int

Validate if value is int/IN32/UINT32 and return it

getLong() → int

Validate if value is long/INT64/UINT64 and return it

getObject() → Caps

Validate if value is Caps/OBJECT and return it

getString() → str

Validate if value is str/STRING and return it

getValueNoType() → Any

type() → chr

Determine the type code for this value

at(index: int) → Value

Get member value by index

clear() → None

Clear all members

dump() → str

static fromBytes(data: bytes) → tuple[Caps, bytes]

Parse a new Caps object from bytes

parse(data: bytes) → tuple[Caps, bytes]

Parse a bytes to the current Caps object

serialize() → bytes

Serialize the Caps object to bytes Format: [4 bytes size][1 byte version][member descriptors][member data]

size() → int

Return the number of members

toString() → str

write(value: Any = None) → Caps

Add a value to the Caps object

writeBinary(value: bytes) → Caps

Write binary data

writeBoolean(value: bool) → Caps

Write a void value

writeDouble(value: float) → Caps

Write a double value

writeFloat(value: float) → Caps

Write a float value

writeInt32(value: int) → Caps

Write an integer value

writeInt64(value: int) → Caps

Write a long integer value

writeObject(value: Caps) → Caps

Write a nested Caps object

writeString(value: str) → Caps

Write a string value

writeUInt32(value: int) → Caps

Write an unsigned integer value

writeUInt64(value: int) → Caps

Write an unsigned long value

writeVoid() → Caps

Write a void value

class pyrokid_cxr_clientm.PacketTypeIds(*values)

Bases: IntEnum

Packet Type IDs used in CXRSocketProtocol Requests and Responses

ARTC_DATA = 8210

ARTC_END = 8211

ARTC_START = 8209

AUDIO_DATA = 12290

AUDIO_END = 12291

AUDIO_START = 12289

AUTH_REQUEST = 4100

AUTH_RESPONSE = 4101

NOTIFY = 4099

REQUEST = 4097

RESPONSE = 4098

ROKID_ACCOUNT_REQUEST = 4102

TRANSFER_DATA = 8194

TRANSFER_END = 8195

TRANSFER_START = 8193