Interface DeviceCreateInfoImmutable

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

Hierarchy

Properties

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

Properties

Optional active

active?: boolean

Set if the device will be active.

chunk_period

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

Chunk division to retain data in the device.

Required for Immutable devices.

chunk_retention

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 Immutable devices.

Optional configuration_params

configuration_params?: ConfigurationParams[]

An array of configuration params

connector

connector: string

Connector ID.

Optional connector_parse

connector_parse?: boolean

If device will use connector parser

Optional description

description?: string

Description of the device.

name

name: string

Device name.

network

network: string

Network ID.

Optional parse_function

parse_function?: string

Javascript code for use as payload parser

Optional serie_number

serie_number?: string

Device serial number.

Optional tags

tags?: TagsObj[]

An array of tags

type

type: "immutable"

Optional visible

visible?: boolean

Set if the device will be visible.

Settings

Member Visibility

Theme

On This Page

activechunk_periodchunk_retentionconfiguration_paramsconnectorconnector_parsedescriptionnamenetworkparse_functionserie_numbertagstypevisible