solarnetwork-api-core
    Preparing search index...

    Class Instruction

    An instruction object.

    Implements

    Index

    Constructors

    Properties

    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.

    Methods