@robotical/roboticaljs/dist/SystemTypeMarty/RICHWElem.d.ts

Javascript/TS library for Robotical products

/**
 * RICHWElem
 *
 * @description
 * Information about a hardware element
 *
 * @field name: string - element name
 * @field type: string - element type
 * @field busName: string - name of bus (e.g. I2C) attached to
 * @field addr: string - address of element on the bus
 * @field addrValid: number - 1 if address is valid
 * @field IDNo: string - unique identifier of element
 * @field whoAmI: string - name of element type
 * @field whoAmITypeCode: string - number of element type
 * @field SN: string - Serial number
 * @field versionStr: string - Version
 * @field commsOk: number - 1 if communications OK, 0 if not, -1 if device is invalid
 */
export type RICHWElem = {
    name: string;
    type: string;
    busName: string;
    addr: string;
    addrValid: number;
    IDNo: string;
    whoAmI: string;
    whoAmITypeCode: string;
    SN: string;
    versionStr: string;
    commsOk: number;
};
export declare class RICHWElemList {
    req: string;
    rslt: string;
    hw: Array<RICHWElem>;
}
export type RICHWElem_Min = {
    n: string;
    t: string;
    I: string;
    w: string;
    W: string;
    S: string;
    v: string;
    c: number;
};
export declare class RICHWElemList_Min {
    req: string;
    rslt: string;
    hw: Array<RICHWElem_Min>;
    static expand(hwMin: RICHWElemList_Min): RICHWElemList;
}
export type RICHWElem_Str = {
    a: string;
};
export type RICHWElemList_Name = {
    rslt: string;
    hw: Array<string>;
};
export declare class RICHWElemList_Str {
    req: string;
    rslt: string;
    hw: Array<RICHWElem_Str>;
    static expand(hwStr: RICHWElemList_Str): RICHWElemList;
    static unesc(s: string): string;
}