TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Interface DeviceCreateInfoHybrid

    Hybrid devices combine immutable telemetry (time-partitioned, with retention via chunk_period + chunk_retention) and editable mutable variables (no retention) in a single device. At insert time each variable is routed to the mutable side when it matches mutable_variable_regex, otherwise it is stored as immutable telemetry.

    interface DeviceCreateInfoHybrid {
        active?: boolean;
        chunk_period: "day" | "month" | "quarter" | "week";
        chunk_retention: number;
        configuration_params?: ConfigurationParams[];
        connector: string;
        connector_parse?: boolean;
        description?: string;
        mutable_variable_regex: string;
        name: string;
        network: string;
        parse_function?: string;
        serie_number?: string;
        tags?: TagsObj[];
        type: "hybrid";
        visible?: boolean;
    }

    Hierarchy

    Index

    Properties

    active? chunk_period chunk_retention configuration_params? connector connector_parse? description? mutable_variable_regex name network parse_function? serie_number? tags? type visible?

    Properties

    active?: boolean

    Set if the device will be active.

    chunk_period: "day" | "month" | "quarter" | "week"

    Chunk division to retain data in the device.

    Required for Hybrid devices.

    chunk_retention: number

    Amount of chunks to retain data according to the chunk_period. Integer between in the range of 0 to 36 (inclusive).

    Required for Hybrid devices.

    configuration_params?: ConfigurationParams[]

    An array of configuration params

    connector: string

    Connector ID.

    connector_parse?: boolean

    If device will use connector parser

    description?: string

    Description of the device.

    mutable_variable_regex: string

    Regex that routes each variable to the mutable side at insert time (unanchored substring match). It must not match every variable or no variable; use a mutable or immutable device for those cases. Required for Hybrid devices. Can only be changed while the device is empty.

    name: string

    Device name.

    network: string

    Network ID.

    parse_function?: string

    Javascript code for use as payload parser

    serie_number?: string

    Device serial number.

    tags?: TagsObj[]

    An array of tags

    type: "hybrid"
    visible?: boolean

    Set if the device will be visible.

    Settings

    Member Visibility

    On This Page

    Properties