SFPTisiLampActuator

ISI Lamp and Appliance Actuator.. Controls the illumination level of a lamp or state of an appliance. Also reports lamp or appliance status with integrated scene control. This profile provides additional required interfaces over the SFPTlampActuator 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 field described in the ISI Requirements section of this profile.

The following figure summarizes the ISI Lamp and Appliance 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 Lamp and Appliance Acutator profile.

Required Use Cases

The following list summarizes the required use cases for the Lamp and Appliance Actuator profile.

Manually turn the lamp or appliance on.
Manually turn the lamp or appliance light off.
Manually toggle the state of the lamp or appliance.
Recall the state and level for a scene.
Store the state and level for a scene.
Learn a scene based on the current lamp state and level.
Report the current lamp or appliance state, level, and scene.
Automatically turn the lamp or appliance on based on occupancy.
Automatically turn the lamp or appliance off based on no occupancy.
Report estimated or actual power factor to a user interface device.
Report the occupancy state to a user interface device.
Prevent looping of feedback updates.
Store a friendly name assigned by a user interface device for the lamp or appliance.

Required Use Cases for Dimmable Devices

The following list summarizes additional required use cases for dimmable devices implementing the Lamp and Actuator profile.

Set an absolute light level for the lamp.
Manually increase the intensity of the lamp.
Manually decrease the intensity of the lamp.

Optional Use Cases for Dimmable Devices

The following list summarizes additional optional use cases for dimmable devices implementing the Lamp and Actuator profile.

Automatically increase the intensity of the lamp based on ambient light level for 1 hour.
Automatically decrease the intensity of the lamp based on ambient light level for 1 hour.
Cancel any change to lamp intensity based on ambient light level.
Report the change in lamp intensity, if any, to a user interface device.

Optional Use Cases for Lamps and Appliances

The following list summarizes additional optional use cases for lamps and appliances.

Report total power consumption.
Report total run-hours.
Wink the state of the lamp or appliance.
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 lamp or appliance location (for example, the room name).
Generate an alarm when the run-time exceeds a specified value.
Specify timing for scene transitions.

Optional Use Cases for Lamps

The following list summarizes additional optional use cases for lamps.

Control the color of the lamp.

Functional Requirements

A lamp or appliance actuator has one or more of the following states:

An on/off state indicating whether or not the lamp or appliance is powered.
A level indicating an illumination level from 0 to 100% (dimmable devices only).
A lamp color (lamps that support color settings only).
An enabled/disabled state (devices that include a Node Object functional block only). This state is described in the Node Object functional profile.
An override state (devices that include a Node Object functional block only). This state is described in the Node Object functional profile.

When the on/off state is changed to on, the level is restored to the same level as the last time the actuator was on.

An actuator can learn or be programmed with a predefined set (preset) of output values. Each of these predefined values is called a scene. Scenes can be individual, for a room or for a complete house depending on the relationship between the devices (connections) and in addition to the output value; each scene can optionally be associated with a delay and a fade time. Different devices may have different definitions for the same scene, so recalling a scene among a group of devices may result in each of the devices going to different levels.

ISI Requirements

Devices implementing the ISI Lamp and Appliance Module profile must implement the interoperable self-installation (ISI) protocol. A functional block implementing this profile must support manual and controlled enrollment with one assembly as described in this section, and may optionally support automatic enrollment for use by UI or gateway applications, and may also support additional assemblies.

A functional block implementing the ISI Lamp and Appliance Module profile will typically be connected with functional blocks implementing one or more of the following functional profiles (functional blocks implementing other profiles may also be connected):

ISI Keypad Profile
ISI Lamp and Appliance Module Profile
ISI Monitor Point Profile
ISI Occupancy Sensor Profile
ISI Sunblind Actuator Profile

A device implementing this profile must include a Connect button for each lamp and appliance module functional block. A lamp and appliance module device may implement multiple lamp and appliance module functional blocks, in which case it will have one Connect button for each functional block. When a Connect button is pressed or an isiOpen controlled enrollment request is received from an enrollment controller, a CSMO message will be broadcast with the values listed in the Offered Value column in the following table. The offered assembly will consist of the nvoSwitch and nviSwitchFb functional block members sharing assembly member number 1.

When a CSMO message is received by an application implementing this profile, the connection invitation will be provisionally approved if the fields of the CSMO message match the Accepted Value column in the following table. A provisionally approved connection invitation will be accepted if the user presses the Connect button, or if an isiCreate controlled enrollment request is received from an enrollment controller.

CSMO Field	Offered Value	Accepted Value
Category	30 (ISI Lighting)	30 (ISI Lighting)
NV Direction	3 (Various)	Any value
Width	1	Any value
Functional Profile	Lamp and Appliance Module Profile Number	Any value
NV Type	SNVT_switch_2 index	SNVT_switch_2 index
Variant	See below	Any value with bits 5 and 6 clear (Variant masked with 0x60 must be 0)
Acknowledged Flag	0	0
Polled Flag	0	0
Scope	0 (Standard)	0 (Standard)

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 LampVariant {

			    unsigned reserved: 3;

			unsigned color: 1;

			    unsigned multipler: 1;

			    unsigned runTime: 1;

			    unsigned energyMonitor: 1;

			    unsigned dimmable: 1;

			} LampVariant;

For example, a Variant value of 0 is a non-dimmable light without color control, run time reporting, or energy reporting; a Variant value of 3 is a dimmable lamp with energy reporting but without color control or run time reporting; a Variant value of 7 is a dimmable lamp with run time and energy reporting but without color control.

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

Use Case Realization

The following table summarizes how the input and output NVs are used to implement the use caess:

	nviLamp	nviLamp	nviLamp	nviLamp	Lamp State	nvoLampFb	nvoLampFb	nvoLampFb	nvoLampFb
Use Case	request	field	setting	scene		request	field	value	scene	Notes
Manually turn light on	SW_SET_ON	N/A	N/A	N/A	On at last level	SW_REPORT_ON	level	0.5 to 100%	current scene or 0
Manually turn light off	SW_SET_OFF	N/A	N/A	N/A	Off	SW_REPORT_OFF	level	0.5 to 100%	last scene or 0
Set an absolute light level	SW_SET_LEVEL	level	0.5 to 100% (on) or 0% (off)	N/A	level	SW_REPORT_ON or SW_REPORT_OFF	level	0.5 to 100% (on) or 0% (off)	current scene or 0
Manually dim light up	SW_INCREASE_LEVEL	change	0.5 to 100%	N/A	last level + delta	SW_REPORT_ON	level	0.5 to 100%	current scene or 0
Manually dim light down	SW_DECREASE_LEVEL	change	0.5 to 100%	N/A	last level - delta	SW_REPORT_ON or SW_REPORT_OFF	level	0 to 100%	current scene or 0
Activate a scene	SW_RECALL_SCENE	N/A	N/A	scene number	recalled scene level	SW_RECALL_SCENE	level	0.5 to 100% (on) or 0% (off)	current scene
Report level and scene	N/A	N/A	N/A	N/A	no change	N/A	level	0 to 100%	current scene or 0
Program a scene	SW_STORE_SCENE	level	0.5 to 100% (on) or 0% (off)	scene number	no change	No change	No change	No change	No change
Learn a scene	SW_LEARN_SCENE	N/A	N/A	scene number	no change	No change	No change	0.5 to 100% (on) or 0% (off)	scene number
Automatically turn light on based on occupancy	SW_SET_OCCUPIED	N/A	N/A	N/A	last scene, occupied level	SW_RECALL_SCENE or SW_SET_OFF	level	0.5 to 100% (on) or 0% (off)	current scene
Automatically turn light off based on no occupancy	SW_SET_UNOCCUPIED	N/A	N/A	N/A	last scene, unoccupied level	SW_RECALL_SCENE or SW_SET_OFF	level	0.5 to 100% (on) or 0% (off)	current scene
Report occupancy	N/A	N/A	N/A	N/A	no change	N/A	N/A	N/A	N/A	Reported using nvoOccupancyFb
Automatically dim light up based on ambient light level for 1 hour	SW_SET_MULTIPLIER	factor	101 to 254%	N/A	last level * factor	SW_REPORT_ON or SW_REPORT_OFF	level	0.5 to 100% (on) or 0% (off)	current scene or 0
Automatically dim light down based on ambient light level for 1 hour	SW_SET_MULTIPLIER	factor	1 to 99%	N/A	last level * factor	SW_REPORT_ON or SW_REPORT_OFF	level	0.5 to 100% (on) or 0% (off)	current scene or 0
Cancel dimming based on ambient light level	SW_SET_MULTIPLIER	factor	100%	N/A	last level	SW_RECALL_SCENE or SW_SET_OFF	level	0.5 to 100% (on) or 0% (off)	current scene or 0
Report multiplier	N/A	N/A	N/A	N/A	no change	N/A	N/A	N/A	N/A	Reported using nvoMultiplierFb

Network Variables

Configuration Properties

nviValue
nvoOccupancyFb
nvoPower
nvoValueFb

nviColor
nvoColorFb
nvoEnergyHi
nvoEnergyLo
nvoMultiplierFb
nvoRunHours

cpName1
cpName2
cpScene

cpDefaultInput
cpEnergyCntInit
cpEnergyHiMaxSendTime
cpEnergyHiMinSendTime
cpEnergyHiSendOnDelta
cpEnergyLoMaxSendTime
cpEnergyLoMinSendTime
cpEnergyLoSendOnDelta
cpFbMajVer
cpFbMinVer
cpInFbDelay
cpLightingGroupEn
cpLoadControlOffset
cpLocation
cpName3
cpOvrBehave
cpOvrValue
cpPowerMaxSendTime
cpPowerMeasurementInterval
cpPowerMinSendTime
cpPowerSendOnDelta
cpRunHrAlarm
cpRunHrInit
cpSceneName
cpSceneTiming
cpValueMaxSendTime
cpValueMinSendTime

Details:

Resource Set: Standard 00:00:00:00:00:00:00:00-0

Index: 87

Obsolete: no

Key: 3041

Inheriting: no

Principal Variable nviValue

Mandatory Network Variables

nviValue Lamp input value.: Scene, setting, occupancy, and/or request input to the lamp.

Member Number:

Base type:

SNVT_switch_2

Direction:

input

Service:

any

nvoValueFb Lamp or appliance feedback output.: Reports the last requested scene, current setting, and power consumption for the lamp or appliance. Power consumption may be measured or estimated.

Member Number:

Base type:

SNVT_switch_2

Direction:

output

Service:

any

nvoPower Power: Reports power consumption. May be an estimate.

Member Number:

Base type:

SNVT_power

Direction:

output

Service:

any

nvoOccupancyFb Occupancy: Occupancy state feedback.

Member Number:

Base type:

SNVT_occupancy

Direction:

output

Service:

any

Optional Network Variables

nvoRunHours Running hours output.: Reports total running hours.

Member Number:

Base type:

SNVT_elapsed_tm

Direction:

output

Service:

any

nvoEnergyHi Electrical energy upper portion.: The nvoEnergyHi reading is incremented and the nvoEnergyLo reading wraps to zero when 1 kWh is reached for the nvoEnergyLo value. May be an estimated value.

Member Number:

Base type:

SNVT_elec_kwh

Direction:

output

Service:

any

nviColor Color:

Member Number:

Base type:

SNVT_color_2

Direction:

input

Service:

any

nvoMultiplierFb Multiplier: Level multiplier feedback. Reset to one after 60 minutes.

Member Number:

Base type:

SNVT_multiplier_s

Direction:

output

Service:

any

nvoColorFb Color feedback.: Color setting feedback; required if nviColor is implemented.

Member Number:

Base type:

SNVT_color_2

Direction:

output

Service:

any

nvoEnergyLo Electrical energy lower portion.: The nvoEnergyHi reading is incremented and the nvoEnergyLo reading wraps to zero when 1 kWh is reached for the nvoEnergyLo value. May be an estimated value.

Member Number:

Base type:

SNVT_elec_whr

Direction:

output

Service:

any

Maximum:

999,9

Mandatory Configuration Properties

cpName1 Name part 1.: Name of the object that the CP applies to. This name can be used by optional user interface applications or display devices.

Member Number:

Base type:

SCPTname1

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

CE_UTF_8

cpScene Scene configuration.: Scene table defining the minimum required scene definition entries. May be used in combination with cpSceneTiming.

Member Number:

Base type:

SCPTscene

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

0 0,0 0 0

cpName2 Name 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:

Base type:

SCPTname2

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

00*12

Optional Configuration Properties

cpDefaultInput Default input.: Input value when updates are not received, at power-on reset, or when overridden.

Member Number:

Base type:

SCPTdefInput

Applies to

nviValue

Array:

not permitted

Default:

00*4

cpInFbDelay Input 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:

Base type:

SCPTinFbDly

Applies to

SFPTisiLampActuator

Array:

not permitted

Maximum:

0 0:0:59:999

Default:

0 0:0:0:0

cpFbMajVer Functional block major version number.: Major version number for the associated functional block. See also cpFbMinVer.

Member Number:

Base type:

SCPTobjMajVer

Applies to

SFPTisiLampActuator

Flags:

constant

Array:

not permitted

Default:

cpFbMinVer Functional block minor version.: Minor version number for the associated functional block. See also cpFbMajVer.

Member Number:

Base type:

SCPTobjMinVer

Applies to

SFPTisiLampActuator

Flags:

device specific, constant

Array:

not permitted

Default:

cpValueMinSendTime Minimum send time (throttle): The minimum period of time between consecutive transmissions of the current value.

Member Number:

Base type:

SCPTminSendTime

Applies to

nvoValueFb

Array:

not permitted

Default:

0,0

cpRunHrInit Running hours counter initialization.: The initial value of the running hours counter network variable.

Member Number:

Base type:

SCPTrunHrInit

Applies to

nvoMultiplierFb

Array:

not permitted

Maximum:

0 255:0:0:0

Default:

0 0:0:0:0

cpRunHrAlarm Running hours alarm threshold level.: The alarm threshold for the running hours counter.

Member Number:

Base type:

SCPTrunHrAlarm

Applies to

nvoMultiplierFb

Array:

not permitted

Maximum:

0 255:0:0:0

Default:

0 0:0:0:0

cpLocation Location: Provides descriptive physical location information related to the object.

Member Number:

Base type:

SCPTlocation

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

00*31

cpEnergyCntInit Energy counter initialization.: The initial value of the energy counter for the associated network variable.

Member Number:

Base type:

SCPTenergyCntInit

Applies to

nviColor

Array:

not permitted

Default:

cpSceneTiming Scene timing configuration.: Scene timing definition used to supplement a scene table created with cpScene. This CP array defines the optional scene table entries for the ISI profiles. When used, it must be used in combination with a cpScene array.

Member Number:

Base type:

SCPTsceneTiming

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

0,0 0,0

cpName3 Name 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:

Base type:

SCPTname3

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

00*12

cpValueMaxSendTime Maximum send time (heartbeat): The maximum period of time between consecutive transmissions of the current value. If this value is set to the invalid value, the heartbeat interval will be two minutes when occupied and 20 minutes when unoccupied--this is the default behavior. Must be implemented as a configuration network variable.

Member Number:

Base type:

SCPTmaxSendTime

Applies to

nvoValueFb

Array:

not permitted

Default:

0,0

cpPowerSendOnDelta Send on delta.: The minimum change required to force transmission of the output value.

Member Number:

Base type:

SCPTsndDelta

Applies to

nvoEnergyHi

Array:

not permitted

Default:

00*3-05

cpSceneName Scene 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:

Base type:

SCPTsceneName

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

CE_UTF_8

cpLightingGroupEn Lighting 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:

Base type:

SCPTlightingGroupEnable

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

0 0 0 0 0 0 0 0

cpPowerMeasurementInterval Power measurement interval.: Time period used for a power measurement; may be used to calibrate a power or energy sensor.

Member Number:

Base type:

SCPTmeasurementInterval

Applies to

SFPTisiLampActuator

Flags:

device specific, manufacturer specific

Array:

not permitted

Default:

0,0

cpOvrBehave Override behavior.: This parameter is used to define the behavior when an override request is received via the Node Object.

Member Number:

Base type:

SCPTovrBehave

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

OV_RETAIN

cpOvrValue Override value.: The value to be used for the input when the functional block is overriden, and the behavior is "SPECIFIED"; if there is no Node object, a non-invalid value for the cpOvrValue state field triggers the override to the specified value, and the normal value is restored when the cpOvrValue state field changes to the invalid value.

Member Number:

Base type:

SCPTovrValue

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

00*4

cpPowerMaxSendTime Maximum send time.: The maximum period of time between consecutive transmissions of the current value.

Member Number:

Base type:

SCPTmaxSendTime

Applies to

nvoEnergyHi

Array:

not permitted

Default:

0,0

cpPowerMinSendTime Minimum send time.: The minimum period of time between consecutive transmissions of the current value.

Member Number:

Base type:

SCPTminSendTime

Applies to

nvoEnergyHi

Array:

not permitted

Default:

0,0

cpEnergyLoMaxSendTime Maximum send time.: The maximum period of time between consecutive transmissions of the current value.

Member Number:

Base type:

SCPTmaxSendTime

Applies to

nvoEnergyLo

Array:

not permitted

Default:

0,0

cpEnergyLoMinSendTime Minimum send time.: The minimum period of time between consecutive transmissions of the current value.

Member Number:

Base type:

SCPTminSendTime

Applies to

nvoEnergyLo

Array:

not permitted

Default:

0,0

cpEnergyLoSendOnDelta Send on delta.: The minimum change required to force transmission of the output value.

Member Number:

Base type:

SCPTsndDelta

Applies to

nvoEnergyLo

Array:

not permitted

Default:

00*4

cpEnergyHiMaxSendTime Maximum send time.: The maximum period of time between consecutive transmissions of the current value.

Member Number:

Base type:

SCPTmaxSendTime

Applies to

nviColor

Array:

not permitted

Default:

0,0

cpEnergyHiMinSendTime Minimum send time.: The minimum period of time between consecutive transmissions of the current value.

Member Number:

Base type:

SCPTminSendTime

Applies to

nviColor

Array:

not permitted

Default:

0,0

cpEnergyHiSendOnDelta Send on delta.: The minimum change required to force transmission of the output value.

Member Number:

Base type:

SCPTsndDelta

Applies to

nviColor

Array:

not permitted

Default:

00*4

cpLoadControlOffset Load control offsets.: Offsets to be used during standby (unoccupied state but home, or sleep mode) and demand-response modes.

Member Number:

Base type:

SCPTloadControlOffset

Applies to

SFPTisiLampActuator

Array:

not permitted

Default:

0,000 0 0,000 106

SFPTisiLampActuator

Overview

Use Cases

Required Use Cases

Required Use Cases for Dimmable Devices

Optional Use Cases for Dimmable Devices

Optional Use Cases for Lamps and Appliances

Optional Use Cases for Lamps

Functional Requirements

ISI Requirements

Use Case Realization

Network Variables

Configuration Properties

Details:

Mandatory Network Variables

Optional Network Variables

Mandatory Configuration Properties

Optional Configuration Properties

Still Not a Member Yet?