solarnetwork-api-core
    Preparing search index...

    Interface Instruction

    An instruction object.

    interface Instruction {
        created: string;
        date: Date;
        id: number;
        instructionDate: string;
        instructionState: InstructionState;
        nodeId: number;
        parameters?: InstructionParameter[];
        resultParameters?: Record<string, any>;
        state:
            | "Unknown"
            | "Queued"
            | "Queuing"
            | "Received"
            | "Executing"
            | "Declined"
            | "Completed";
        statusDate: string;
        topic: string;
        updateDate: Date;
    }

    Implements

    Index
    created date id instructionDate instructionState nodeId parameters? resultParameters? state statusDate topic updateDate
    created: string

    The instruction creation date.

    date: Date

    The instruction action date.

    id: number

    A unique identifier.

    instructionDate: string

    The instruction action date.

    instructionState: InstructionState

    The instruction state.

    nodeId: number

    The ID of the node the instruction targets.

    parameters?: InstructionParameter[]

    Parameters for the instruction.

    resultParameters?: Record<string, any>

    Result parameters returned with the instruction status update.

    state:
        | "Unknown"
        | "Queued"
        | "Queuing"
        | "Received"
        | "Executing"
        | "Declined"
        | "Completed"

    The instruction state.

    statusDate: string

    The last instruction status change date.

    topic: string

    The instruction topic.

    updateDate: Date

    The last instruction status date.

    Settings
    Member Visibility

    On This Page
    Properties