hub.item.value.percent.apply

Connection type: UI
Permissions: EZLO: WRITE/EDIT

This command sets current value between minimum and maximum in position specified by current level plus percent. Positive percent increases value level and negative decreases. Simplified formula: newValue = currentValue + percentFromRange

Implementation: newValue = round( currentValue + ( maxValue – minValue ) * percent / 100 ) newValue always will be in range: [minValue , maxValue ].

				
					if( newValue > maxValue )
    newValue = maxValue;
else if( newValue < minValue )
    newValue = minValue;

Edit

Field	Type	Required	Description
_id	string	+	Item object id
percent	int	+	Value must belong to range from -100 to 100

Edit

Field	Type	Required	Description
newValue	float	+	New value of an item.
scale	string	–	Scale for temperature items, one of (celsius, fahrenheit)
valueType	string	–	temperature for temperature items

Edit

Broadcast	Description
*hub.item.updated*	Informs about item changed

Edit

Code	Message	Data	Reason
-32600	Bad request, id is empty	rpc.params.empty._id
-32602	Value has invalid type	rpc.params.type.invalid
-32602	Currently only items with type int are supported	rpc.params.type.invalid
-32602	Value is not in valid range	rpc.params.range.invalid
-32500	rpc.unknown.error	Unknown error	Item associated with this id (_id) has no minimal and maximal value fields
-32500	rpc.unknown.error	Unknown error	Item not found by id: _id
-32500	rpc.unknown.error	Unknown error	Value ‘value_name‘ has invalid type. Type ‘unsupported_type_name‘ is not supported. Item id: _id
-32500	rpc.unknown.error	Unknown error	Value ‘value_name‘ is not in valid range. Valid range is: [min, max]. Item id: _id

Edit

Request
Response

Edit

				
					{
    "method": "hub.item.value.percent.apply",
    "id": "<request_id>",
    "params": {
        "_id" : "5cf0dc8c7f000068d223e88a",
        "percent" : 40
    }
}

Edit

Let’s assume we have dimmer with minimal value 0 and maximal 99.
Current value is 30 The percent is 40 and new value will be 70.

				
					{
    "error": null,
    "id": "_ID_",
    "result": {
        "newValue" : 70
    }
}

In case of we have a thermostat with minimal value 0 and maximal 40.
Current value is 30 The percent is 10 and new value will be 34.

				
					{
    "error": null,
    "id": "_ID_",
    "result": {
        "newValue" : 34,
        "scale": "celsius",
        "valueType": "temperature"
    }
}