SFPTisiSunblindActuator

ISI Sunblind and Motor Control Actuator..  Controls the position and rotation angle of a sunblind. Also reports sunblind status with integrated scene control. This profile provides additional required interfaces over the SFPTsunblindActuator profile to simplify use in self-installed networks.  

Overview

This profile uses a profile-specific Usage field for the program ID. The Usage field must be set to the same value as the Variant described in the ISI Requirements section of this profile.

The following figure summarizes the ISI Sunblind Actuator profile inputs and outputs.

This profile was generated automatically by the NodeBuilder® Resource Report Generator.

Use Cases

The following sections summarize the use cases supported by the Sunblind Acutator profile.

Required Use Cases

The following list summarizes the required use cases for the Sunblind profile.

  • Manually sets the position of the sunblind.
  • Recall the position of the sunblind for a scene.
  • Store the position of the sunblind for a scene.
  • Learn a scene based on the current sunblind position.
  • Report the current sunblind position and scene.
  • Prevent looping of feedback updates.
  • Store a friendly name assigned by a user interface device for the sunblind.

Optional Use Cases for Sunblinds

The following list summarizes additional optional use cases for sunblinds.

  • Manually sets the rotation angle of the sunblind.
  • Recall the position and rotation angle for a scene.
  • Store the position and rotation angle for a scene.
  • Learn a scene based on the current sunblind position and rotation angle.
  • Report the current sunblind position, rotation angle, and scene.
  • Report current power level to a user interface device.
  • Wink the state (running or stopped) of the sunblind.
  • Specify a heartbeat rate for the feedback output.
  • Specify an update throttle for the feedback output.
  • Specify a major and minor model number for the functional block implementation.
  • Store a friendly name for the sunblind location (for example, the room name).
  • Specify timing for scene transitions.

ISI Requirements

Devices implementing the ISI Sunblind Actuator profile must implement the interoperable self-installation (ISI) protocol. The types of connections that will be accepted by devices implementing this profile are TBD. Devices implementing this profile must support manual and controlled enrollment and may optionally support automatic connections for use by gateway applications. When offering a connection, the Variant field will be used to specify which optional network variables and features are available. The Variant values are defined by the following C declaration (using Neuron C bit packing):

typedef struct SunblindVariant {
unsigned reserved: 5;
unsigned position: 1;
unsigned rotationAngle: 1;
unsigned powerMonitor: 1;
} SunblindVariant;

For example, a Variant value of 0 is a sunblind without rotation angle or power level reporting; a Variant value of 1 is a sunblind with power level reporting; a Variant value of 3 is a sunblind with rotation angle and power level reporting.

The Variant value will also be specified in the Usage field of the program ID for any device implementing this profile.

 

Network Variables

Configuration Properties

nviValue
nvoOccupancyFB
nvoValueFb

nvoPower
nvoRotation
nvoRunHours

cpName1
cpName2
cpScene

cpDefaultInput
cpFbMajVer
cpFbMinVer
cpInFbDelay
cpLightingGroupEn
cpLoadControlOffset
cpLocation
cpMaxSendTime
cpMinSendTime
cpName3
cpPowerLimit
cpSceneName
cpSceneTiming

 

Details:

Resource Set: Standard 00:00:00:00:00:00:00:00-0
Index: 93
Obsolete: no
Key: 6112
Inheriting: no
Principal Variable nviValue


Mandatory Network Variables

nviValueSunblind input value.:   Scene, setting and/or request input to the sunblind actuator. 
Member Number: 1
Base type:
SNVT_switch_2
Direction: input
Service: any
nvoValueFbSunblind or appliance feedback output.:   Reports the last requested scene and current setting. 
Member Number: 2
Base type:
SNVT_switch_2
Direction: output
Service: any
nvoOccupancyFBOccupancy feedback.:    
Member Number: 4
Base type:
SNVT_occupancy
Direction: output
Service: any


Optional Network Variables

nvoPowerPower:   Reports the current power level of the sunblind or appliance. Power level may be measured or estimated to detect blocked motors. 
Member Number: 3
Base type:
SNVT_power
Direction: output
Service: any
nvoRunHoursRunning hours output.:   Reports total running hours. 
Member Number: 5
Base type:
SNVT_elapsed_tm
Direction: output
Service: any
nvoRotationAngular distance.:   Report the rotation angle. 
Member Number: 6
Base type:
SNVT_angle_deg
Direction: output
Service: any


Mandatory Configuration Properties

cpName1Name part 1.:   Part 1 of the name of the functional block to be used by optional user interface applications. May optionally used with SCPTname2 and SCPTname3. Must be implemented as a configuration network variable.  
Member Number: 1
Base type:
SCPTname1
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: CE_UTF_8
cpName2Name part 2.:   Part 2 of the name of the functional block to be used by optional user interface applications. Must be used with SCPTname1 and may optionally be used with SCPTname3. This part is concatenated after part 1, and may optionally be followed by part 3. Must be implemented as a configuration network variable.  
Member Number: 2
Base type:
SCPTname2
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: 00*12
cpSceneScene configuration.:   Scene definition used to create a scene table. This SCPT defines the minimum entries required by the ISI profiles. May be used in combination with SCPTsceneTiming.  
Member Number: 3
Base type:
SCPTscene
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: 0 0,0 0 0


Optional Configuration Properties

cpDefaultInputDefault input.:   Input value when updates are not received, at power-on reset, or when overridden. 
Member Number: 4
Base type:
SCPTdefInput
Applies to nviValue
Array: not permitted
Default: 00*4
cpInFbDelayInput value feedback delay.:   The time period after the last update in a succession of changes to the input, before the feedback output is updated. 
Member Number: 5
Base type:
SCPTinFbDly
Applies to SFPTisiSunblindActuator
Array: not permitted
Maximum: 0 0:0:59:999
Default: 0 0:0:0:0
cpFbMajVerObject major version number.:   The major version number for the object. 
Member Number: 6
Base type:
SCPTobjMajVer
Applies to SFPTisiSunblindActuator
Flags: constant
Array: not permitted
Default: 0
cpFbMinVerObject minor version number.:   The minor version number for the object. 
Member Number: 7
Base type:
SCPTobjMinVer
Applies to SFPTisiSunblindActuator
Flags: device specific, constant
Array: not permitted
Default: 0
cpMinSendTimeMinimum send time.:   The minimum period of time between consecutive transmissions of the current value. 
Member Number: 8
Base type:
SCPTminSendTime
Applies to nvoValueFb
Array: not permitted
Default: 0,0
cpLocationLocation:   Provides descriptive physical location information related to the object. 
Member Number: 10
Base type:
SCPTlocation
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: 00*31
cpSceneTimingScene timing configuration.:   Scene timing definition used to supplement a scene table created with a SCPTscene array. This SCPT defines the optional scene table entries for the ISI profiles. When used, it must be used in combination with a SCPTscene array.  
Member Number: 11
Base type:
SCPTsceneTiming
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: 0,0 0,0
cpName3Name part 3.:   Part 3 of the name of the functional block to be used by optional user interface applications. Must be used with SCPTname1 and SCPTname2. This part, if present, is concatenated with parts 1 and 2. Must be implemented as a configuration network variable.  
Member Number: 12
Base type:
SCPTname3
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: 00*12
cpMaxSendTimeMaximum send time.:   The maximum period of time between consecutive transmissions of the current value. ISI heartbeats are specified if this value is set to the invalid value. 
Member Number: 13
Base type:
SCPTmaxSendTime
Applies to nvoValueFb
Array: not permitted
Default: 0,0
cpSceneNameScene name.:   Name for a scene to be used by optional user interface applications. Used to create an array that supplements a scene table created with a SCPTscene array. 
Member Number: 14
Base type:
SCPTsceneName
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: CE_UTF_8
cpPowerLimitMaximum power.:   Power level at which the sunblind actuator detects a blocked motor and switches off automatically. 
Member Number: 15
Base type:
SCPTmaxPower
Applies to nvoPower
Array: not permitted
Default: 0,0
cpLightingGroupEnLighting group enable.:   Bit masks to enable or disable up to 64 ISI lighting groups. Group 0 is not used. Groups may also be enabled or disabled using a SNVT_switch_2 update. 
Member Number: 16
Base type:
SCPTlightingGroupEnable
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: 0 0 0 0 0 0 0 0
cpLoadControlOffsetLoad control offsets.:   Offsets to be used during standby (unoccupied state but home, or sleep mode) and demand-response modes. 
Member Number: 17
Base type:
SCPTloadControlOffset
Applies to SFPTisiSunblindActuator
Array: not permitted
Default: 0,000 0 0,000 106