« Back to Product

Documentation

Send feedback!

Shutter

Require: Symcon >= 8.0

Parameter

Information about the visual properties and meanings of the parameters can be found in the Object Presentation.

Name Type Parameter Description
PRESENTATION String The ID of the presentation VARIABLE_PRESENTATION_SHUTTER
{6075FC22-69AF-B110-3749-C24138883082}
USAGE_TYPE Integer Usage Type 0: Open, 1: Rotation
OPEN_OUTSIDE_VALUE Integer/Float Open At / Outside At
CLOSE_INSIDE_VALUE Integer/Float Closed At / Inside At
MAX_ROTATION_INSIDE Integer/Float Maximum Rotation Inside
MAX_ROTATION_OUTSIDE Integer/Float Maximum Rotation Outside
SUN_POSITION Integer Sun Position 0: Left, 1: Right, 2: (None)

Templates

// Registers a variable that displays slats rotated to the right.
$this->RegisterVariableFloat('Lamelle', 'Lamelle', [
    'PRESENTATION' => VARIABLE_PRESENTATION_SHUTTER,
    'TEMPLATE' => VARIABLE_TEMPLATE_SHUTTER_LAMELLA_RIGHT,
]);
Name Constant GUID
Slat right VARIABLE_TEMPLATE_SHUTTER_LAMELLA_RIGHT {3BE75DE9-7D84-C082-2E77-9ED3AEE04D63}
Slat left VARIABLE_TEMPLATE_SHUTTER_LAMELLA_LEFT {22A0DF9C-C200-154A-641B-3A3CB096DB6D}

Examples

// When registering a variable for PHP modules
// A variable that represents the opening of the shutter. With a variable value of 150, the presentation is closed - at 0 open.
$this->RegisterVariableInteger('Shutter', 'Shutter', [
    'PRESENTATION' => VARIABLE_PRESENTATION_SHUTTER,
    'CLOSE_INSIDE_VALUE' => 150,
    'USAGE_TYPE' => 0 /* Open */,
    'SUN_POSITION' => 2 /* None */,
    'OPEN_OUTSIDE_VALUE' => 0,
]);
// A variable that represents the rotation of slats. With a variable value of 100, the presentation is rotated outwards - at 0 inside.
$this->RegisterVariableInteger('Shutter', 'Shutter', [
    'PRESENTATION' => VARIABLE_PRESENTATION_SHUTTER,
    'CLOSE_INSIDE_VALUE' => 100,
    'OPEN_OUTSIDE_VALUE' => 0,
    'USAGE_TYPE' => 1 /* Rotation */,
    'SUN_POSITION' => 1 /* Right */,
    'MAX_ROTATION_INSIDE' => -30,
    'MAX_ROTATION_OUTSIDE' => 30,
]);

// For existing variables via script
// A variable that represents the opening of the shutter. With a variable value of 150, the presentation is closed - at 0 open.
IPS_SetVariableCustomPresentation(12345, [
    'PRESENTATION' => VARIABLE_PRESENTATION_SHUTTER,
    'CLOSE_INSIDE_VALUE' => 150,
    'USAGE_TYPE' => 0 /* Open */,
    'SUN_POSITION' => 2 /* None */,
    'OPEN_OUTSIDE_VALUE' => 0,
]);
// A variable that represents the rotation of slats. With a variable value of 100, the presentation is rotated outwards - at 0 inside.
IPS_SetVariableCustomPresentation(12345, [
    'PRESENTATION' => VARIABLE_PRESENTATION_SHUTTER,
    'CLOSE_INSIDE_VALUE' => 100,
    'OPEN_OUTSIDE_VALUE' => 0,
    'USAGE_TYPE' => 1 /* Rotation */,
    'SUN_POSITION' => 1 /* Right */,
    'MAX_ROTATION_INSIDE' => -30,
    'MAX_ROTATION_OUTSIDE' => 30,
]);
Any questions?