@espressif/rainmaker-base-cdf
    Preparing search index...

    Class ESPCDFGroup

    Implements

    Index

    Constructors

    constructor

    Properties

    _raw accessType? customData? description? events fabricDetails? fabricId? id identifier isMatter? isPrimaryUser? metadata? mutuallyExclusive? name nodeDetails? nodeIds operations parentId? subGroups? totalNodes? type?

    Methods

    addNodes convertToMatterFabric createAutomation createScene createSchedule createSubGroup delete dispose getAutomations getFabricDetails getNodes getNodesWithDetails getSceneCapableDevices getScenes getScheduleCapableDevices getSchedules getSharingInfo getSubGroups issueNodeNoC issueUserNoC leave removeNodes removeSharingFor setParams share startCommissioning subscribe transfer updateGroupInfo updateMetadata

    Constructors

    Properties

    _raw

    _raw: any
    accessType?: string

    Normalized user access to this group: RMNG maps SDK accessType; classic RM maps from isPrimaryUser (primary | secondary). RM has no subgroup-share mode.

    customData?: Record<string, any>
    description?: string
    events: ESPCDFOperationEventEmitter<ESPCDFGroup, ESPCDFGroupOperationType>
    fabricDetails?: ESPCDFMatterFabricDetails
    fabricId?: string
    id: string
    identifier: string
    isMatter?: boolean
    isPrimaryUser?: boolean
    metadata?: Record<string, any>
    mutuallyExclusive?: boolean
    name: string
    nodeDetails?: ESPCDFNode[]
    nodeIds: string[]
    operations: ESPCDFGroupOperation
    parentId?: string
    subGroups?: ESPCDFGroup[]
    totalNodes?: number
    type?: string

    Methods

    • Gets all automations associated with nodes in this group (including subgroups)

      Fetches nodes from the group and extracts automation configurations from their services. Returns an array of ESPCDFAutomation entities that can be stored in AutomationStore.

      Returns Promise<ESPCDFPaginatedAPIResponse<ESPCDFAutomation[]>>

      Promise<ESPCDFAutomation[]> Array of automation entities for this group's nodes

      Error if operation not supported or automation extraction fails

      const automations = await group.getAutomations();
      // Automations will be automatically added to automationStore via callback

    • Lists devices in this group that can participate in scenes (nodes exposing the scenes service), one row per device with params, plus whether the node has reached its max scene count.

      Used for scene device selection / provisioning flows — not a raw node list.

      Returns Promise<
          { device: ESPCDFDevice; isMaxSceneReached: boolean; node: ESPCDFNode }[],
      >

      Promise<Array<{ node: ESPCDFNode; device: ESPCDFDevice; isMaxSceneReached: boolean }>>

      Error if the adaptor does not implement this operation

      const rows = await group.getSceneCapableDevices();

    • Lists devices in this group that can participate in schedules (nodes exposing the schedules service), one row per device with params, plus whether the node has reached its max schedule count (same shape as scene rows: isMaxSceneReached is reused for the schedule service bound).

      Used for schedule device selection / provisioning flows.

      Returns Promise<
          { device: ESPCDFDevice; isMaxSceneReached: boolean; node: ESPCDFNode }[],
      >

      Promise<Array<{ node: ESPCDFNode; device: ESPCDFDevice; isMaxSceneReached: boolean }>>

      Error if the adaptor does not implement this operation

      const rows = await group.getScheduleCapableDevices();

    • Gets all schedules associated with nodes in this group (including subgroups)

      Fetches nodes from the group and extracts schedule configurations from their services. Returns an array of ESPCDFSchedule entities that can be stored in ScheduleStore.

      Returns Promise<ESPCDFSchedule[]>

      Promise<ESPCDFSchedule[]> Array of schedule entities for this group's nodes

      Error if operation not supported or schedule extraction fails

      const schedules = await group.getSchedules();
      // Schedules will be automatically added to scheduleStore via callback

    • Publishes param values through the adaptor group-level setParams path when supported.

      Parameters

      • payload: Record<string, Record<string, unknown>>

        The payload contains the value to publish and the target objects which represent the row of device and param that should receive the broadcast value for the given param.

      Returns Promise<unknown>

      Adaptor-specific result.

      Error when the adaptor does not implement ESPCDFGroupOperation.setParams.

    • Parameters

      • params: Record<string, any>

      Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods