Dimmable Plug-in Unit

The Dimmable Plug-in Unit device is typically used in nodes that contain a controllable mains plug or adaptor which includes an adjustable output (to a lamp). It may be controlled from a controller device such as a Dimmer Switch or a Non-colour Controller.

The Device ID is 0x010B.
The header file for the device is dimmable_plug.h.
The clusters supported by the device are listed in Section 3.12.1.
The device structure, tsZLO_DimmablePlugDevice, is listed in Section 3.12.2.
The endpoint registration function for the device, eZLO_RegisterDimmablePlugEndPoint(), is detailed in Section 3.12.3.

Supported clusters

The clusters supported by the Dimmable Plug-in Unit device are listed in the table below.

Table 25. Clusters for Dimmable Plug-in Unit
Server (Input) side	Client (Output) side
Mandatory
Basic
Identify
Groups
Scenes
On/Off
Level control
Optional
	OTA upgrade
The mandatory attributes within each cluster for this device type are indicated in the ZigBee Lighting and Occupancy Device Specification (15-0014-01).

Parent topic:Dimmable Plug-in Unit

Device Structure

The following tsZLO_DimmablePlugDevice structure is the shared structure for a Dimmable Plug-in Unit device:

typedefstruct
{
   tsZCL_EndPointDefinitionsEndPoint;
    /* Cluster instances */
    tsZLO_DimmablePlugDeviceClusterInstances sClusterInstance;
    #if (defined CLD_BASIC) && (defined BASIC_SERVER)
        /* Basic Cluster - Server */
        tsCLD_Basic sBasicServerCluster;
    #endif
    #if (defined CLD_IDENTIFY) && (defined IDENTIFY_SERVER)
    /* Identify Cluster - Server */
    tsCLD_Identify sIdentifyServerCluster;
    tsCLD_IdentifyCustomDataStructure
            sIdentifyServerCustomDataStructure;
    #endif
    #if (defined CLD_ONOFF) && (defined ONOFF_SERVER)
    /* On/Off Cluster - Server */
    tsCLD_OnOff sOnOffServerCluster;
    tsCLD_OnOffCustomDataStructure sOnOffServerCustomDataStructure;
    #endif
    #if (defined CLD_GROUPS) && (defined GROUPS_SERVER)
        /* Groups Cluster - Server */
        tsCLD_Groups sGroupsServerCluster;
        tsCLD_GroupsCustomDataStructure sGroupsServerCustomDataStructure;
    #endif
    #if (defined CLD_SCENES) && (defined SCENES_SERVER)
    /* Scenes Cluster - Server */
    tsCLD_Scenes sScenesServerCluster;
    tsCLD_ScenesCustomDataStructure sScenesServerCustomDataStructure;
    #endif
    #if (defined CLD_LEVEL_CONTROL) && (defined LEVEL_CONTROL_SERVER)
    /* LevelControl Cluster - Server */
    tsCLD_LevelControl sLevelControlServerCluster;
    tsCLD_LevelControlCustomDataStructure
                sLevelControlServerCustomDataStructure;
    #endif
    #if (defined CLD_OTA) && (defined OTA_CLIENT)
    /* OTA cluster - Client */
    tsCLD_AS_Ota sCLD_OTA;
    tsOTA_Common sCLD_OTA_CustomDataStruct;
    #endif
} tsZLO_DimmablePlugDevice;

Parent topic:Dimmable Plug-in Unit

Registration Function

The following eZLO_RegisterDimmablePlugEndPoint() function is the endpoint registration function for a Dimmable Plug-in Unit device.

teZCL_Status eZLO_RegisterDimmablePlugEndPoint(
        uint8 u8EndPointIdentifier,
        tfpZCL_ZCLCallBackFunction cbCallBack,
        tsZLO_DimmablePlugDevice *psDeviceInfo);

Description

This function is used to register an endpoint which supports a Dimmable Plug-in Unit device. The function must be called after eZCL_Initialise().

The specified identifier for the endpoint is a number in the range 1 to 240 (endpoint 0 is reserved for ZigBee use). Application endpoints are normally numbered consecutively starting at 1. The specified number must be less than or equal to the value of ZLO_NUMBER_OF_ENDPOINTS defined in the zcl_options.h file, which represents the highest endpoint number used for applications.

While invoking this function, specify a user-defined callback function, which is invoked when an event associated with the endpoint occurs. This callback function is defined according to the typedef:

typedef void(* tfpZCL_ZCLCallBackFunction)
(tsZCL_CallBackEvent *pCallBackEvent);

Also provide a pointer to a tsZLO_DimmablePlugDevice structure, described in Device Structure. This structure stores all variables relating to the color Controller device associated with the endpoint. The sEndPoint and sClusterInstance fields of this structure are set by this function and must not be directly written to by the application.

The function is called multiple times if more than one endpoint is being used - for example, if more than one Dimmable Plug-in Unit device is housed in the same hardware, sharing the same module.

Parameters

u8EndPointIdentifier: Endpoint that is to be associated with the registered structure and callback function.
cbCallBack: Pointer to the function that is used to indicate events to the application for this endpoint.
psDeviceInfo: Pointer to the structure that acts as storage for all variables related to the device being registered on this endpoint (see Device Structure). The sEndPoint and sClusterInstance fields are set by this register function for internal use and must not be written to by the application.

Returns

E_ZCL_SUCCESS
E_ZCL_FAIL
E_ZCL_ERR_PARAMETER_NULL
E_ZCL_ERR_PARAMETER_RANGE
E_ZCL_ERR_EP_RANGE
E_ZCL_ERR_CLUSTER_0
E_ZCL_ERR_CALLBACK_NULL
E_ZCL_ERR_CLUSTER_NULL
E_ZCL_ERR_SECURITY_RANGE
E_ZCL_ERR_CLUSTER_ID_RANGE
E_ZCL_ERR_MANUFACTURER_SPECIFIC
E_ZCL_ERR_ATTRIBUTE_TYPE_UNSUPPORTED
E_ZCL_ERR_ATTRIBUTE_ID_ORDER
E_ZCL_ERR_ATTRIBUTES_ACCESS

The above codes are described in the ZCL User Guide (JNUG3132).

Parent topic:Dimmable Plug-in Unit

Parent topic:Lighting and Occupancy Device Types