Control Zone Fan

Control fans in a zone by setting their speed level.

Description

The zone fan control allows you to manage multiple fans in a zone by setting:

• Fan speed level (1-5)

Example

Request Topic

LYT/41e0d6b2-37de-43d8-a348-4ba94853b6cd/ZONE/CONTROL

Request Payload

Set fan speed:

{
   "version": "v1.0",
   "type": "fan",
   "address": 50646,
   "fan_speed": 3
}

Field Descriptions

Field	Type	Range	Description
version	string	"v1.0"	API version identifier
type	string	"fan"	Message type for fan control
address	number	zone address	Address of the target zone
fan_speed	number	1-5	Fan speed level (1=lowest, 5=highest)

Response Topic

LYT/41e0d6b2-37de-43d8-a348-4ba94853b6cd/ZONE/E/STATUS

Response Payload

Success Response

{
   "version": "v1.0",
   "message": "success",
   "type": "fan",
   "address": 50646,
   "fan": {
      "fan_speed": 3
   }
}

Error Handling

The API may return various error responses based on different scenarios:

1. Constraint Error (Code: 3005)

a. Fan Speed Constraint:

{
   "message": "error",
   "message_type": {         
      "code": 3005,
      "message": "fan_speed must be an integer between 0 to 4",
      "errorCode": "CONSTRAINT_ERROR"
   },
   "type": "fan_speed",
   "address": 50646
}

b. Version Constraint:

{
   "message": "error",
   "message_type": {
      "code": 3005,
      "message": "version must be equal to v1.0",
      "errorCode": "CONSTRAINT_ERROR"
   },
   "type": "fan_speed",
   "address": 50646
}

c. Type Constraint:

{
   "message": "error",
   "message_type": {      
      "code": 3005,
      "message": "type must be one of the following values: cct, dimmer, switch, fan_speed, curtain-level, rgb",
      "errorCode": "CONSTRAINT_ERROR"
   },
   "type": "fan_speed",
   "address": 50646
}

d. Address Constraint:

{
   "message": "error",
   "message_type": {
      "code": 3005,
      "message": "address must be a number conforming to the specified constraints",
      "errorCode": "CONSTRAINT_ERROR"
   },
   "type": "fan_speed",
   "address": 50646
}

Constraint errors occur in the following cases:

1. Fan Speed Constraints:

   • Fan speed value must be between 0 to 4
   • Fan speed field is missing
   • Fan speed field must be a number

2. Version Constraints:

   • Version is not exactly "v1.0"
   • Version field is missing
   • Version field has incorrect format

3. Type Constraints:

   • Type must be "fanspeed"
   • Type field is missing
   • Type field has incorrect value

4. Zone Address Constraints:

   • Zone address must be a number
   • Zone address field is missing
   • Zone address field has incorrect type

Resolution:

• Ensure fanspeed is between 0-4
• Always use "v1.0" as the version value
• Use "fanspeed" as the type value
• Ensure address is a valid number
• Validate all parameters before sending

2. Zone Not Found Error (Code: 2005)

{
   "message": "error",
   "message_type": {
      "code": 2005,
      "message": "Zone not found",
      "errorCode": "ZONE_NOT_FOUND"
   },
   "type": "curtain",
   "address": 50646
}

When it occurs:

• The specified address doesn't exist
• Zone has been deleted
• Zone is not configured

How to resolve:

1. Verify the address is correct
2. Check if the zone exists in the system
3. Ensure the zone is properly configured
4. Use zone management API to list available zones

Error Code Summary

Code	Error Code	Description	Solution
3005	CONSTRAINT_ERROR	Parameter validation failed	Check input values
2005	ZONE_NOT_FOUND	Zone not available	Verify zone exists
2002	PROJECT_NOT_FOUND	Project doesn't exist	Check project_uuid
3002	REQUEST_TIMEOUT	Request took too long	Check connectivity