.
|
|
Network Variables | Configuration Properties |
nviExceptionOvr nviLocalOcc nviManualOvr nviStartOffset nviStopOffset nvoOccPri nvoOccPriTOD nvoOccSec nvoOccSecTOD nvoSchedStat
nvoSchedValue
| cpMaxSendTime cpMinSendTime cpObjMajVer cpObjMinVer cpOccBehavior cpOccThresholds cpOccTimeout cpRandomizationInterval cpScheduleException cpScheduleFriday cpScheduleHoliday cpScheduleMonday cpScheduleSaturday cpScheduleSunday cpScheduleThursday cpScheduleTuesday cpScheduleWednesday cpSchedulerOptions
cpSunriseTime cpSunsetTime
|
|
Details: |
Resource Set:
| Standard 00:00:00:00:00:00:00:00-0 |
Index:
| 99 |
Obsolete:
| no |
Key:
| 17 |
Inheriting:
| no |
Principal Variable
| nvoOccPri |
Mandatory Network Variables |
nviStartOffset | Start time offset.:
Offset value applied to a scheduled start time for any scheduled Occupied event. The value may be generated by another functional block such as an optimal start-stop functional block. The value can be used to offset a scheduled start time to implement an optimal start or optimal stop algorithm, or to stagger start times to minimize demand spikes.
|
Member Number:
| 1 |
Base type:
| | Direction:
| input | Service:
| any |
|
nviStopOffset | Stop time offset.:
Offset value applied to a scheduled stop time for any scheduled Unccupied event. The value may be generated by another functional block such as an optimal start-stop functional block. The valuet can be used to offset a scheduled stop time to implement an optimal stop algorithm, or to stagger stop times to minimize demand spikes.
|
Member Number:
| 2 |
Base type:
| | Direction:
| input | Service:
| any |
|
nviManualOvr | Manual schedule override.:
Highest priority override--this input overrides the daily schedule, the Exception Override input, the Local Occupancy input, the Scheduled Exception Event input, and the Scheduled Vacation/Holiday Event input. The Offset for Start and Offset for Stop values do not apply to this override.
|
Member Number:
| 3 |
Base type:
| | Direction:
| input | Service:
| any |
|
nviExceptionOvr | Exception schedule override.:
Second highest priority override--does not override the Manual Override input. This input overrides the daily schedule, the Local Occupancy input, the Scheduled Exception Event input, and the Scheduled Vacation/Holiday Event input. The Offset for Start and Offset for Stop values do not apply to this override.
|
Member Number:
| 4 |
Base type:
| | Direction:
| input | Service:
| any |
|
nvoOccPriTOD | Primary time-of-day occupancy.:
Primary scheduled occupancy event, which includes current and next state values that are the result of the normal schedule overlaid with any exceptions and/or overrides; and where the Local Occupancy input(s) is/are considered in the determination of the output value (in contrast to the Secondary Time-of-Day Occupancy, which does not consider Local Occupancy).
|
Member Number:
| 5 |
Base type:
| | Direction:
| output | Service:
| unacknowledged, repeated |
|
nvoOccSecTOD | Secondary time-of-day occupancy.:
Secondary scheduled occupancy event, which includes current and next state values that are the result of the normal schedule overlaid with any exceptions and/or overrides; but where the Local Occupancy input(s) is/are excluded from consideration in the determination of the output value (in contrast to the Primary Time-of-Day Occupancy, which always considers Local Occupancy).
|
Member Number:
| 6 |
Base type:
| | Direction:
| output | Service:
| unacknowledged, repeated |
|
nvoOccPri | Primary occupancy.:
Primary scheduled occupancy value which is the result of the normal schedule overlaid with any exceptions and/or overrides; and where the Local Occupancy input(s) is/are considered in the determination of the output value (in contrast to the Secondary Time-of-Day Occupancy, which does not consider Local Occupancy). Matches the value of the nvoOccPriTOD current_state field.
|
Member Number:
| 7 |
Base type:
| | Direction:
| output | Service:
| unacknowledged, repeated |
|
nvoOccSec | Secondary occupancy.:
Secondary scheduled occupancy value which is the result of the normal schedule overlaid with any exceptions and/or overrides; but where the Local Occupancy input(s) is/are excluded from consideration in the determination of the output value (in contrast to the Primary Time-of-Day Occupancy, which always considers Local Occupancy). Matches the value of the nvoOccSecTOD current_state field.
|
Member Number:
| 8 |
Base type:
| | Direction:
| output | Service:
| unacknowledged |
|
nviLocalOcc | Local occupancy.:
Local occupancy from one or more occupancy sensors and occupancy sensor managers. The Default Occupancy Behavior CP determines the functional block response to this input. This input is the third highest prioirty override after the Manual Override and Exception Override inputs. It overrides the daily schedule, the Scheduled Exception Event input, and the Scheduled Vacation/Holiday Event input. The functional block must manage inputs from up to 50 devices reporting occupancy or bypass, tracking the time since last occupancy or bypass report of each device by source address; a device is dropped from the active list if it reports an unoccupied, standby, or invalid value, or if there is no update from the device in the time interval specified by the Occupancy Maximum Receive Time CP. If 50 devices are reporting occupied or bypass status and an occupied or bypass input is received from a device that is not on the list, the oldest device on the list is dropped and the new device is added.
|
Member Number:
| 9 |
Base type:
| | Direction:
| input | Service:
| any |
|
nvoSchedStat | Scheduler status.: Type of schedule that is active.
|
Member Number:
| 10 |
Base type:
| | Direction:
| output | Service:
| any |
|
Optional Network Variables |
nvoSchedValue | General-purpose scheduler output value.: Index from scheduler that selects entry in SCPTvalueDefinition array, or is a direct value output.
|
Member Number:
| 11 |
Base type:
| | Direction:
| output | Service:
| any |
|
Mandatory Configuration Properties |
cpScheduleSunday | Sunday schedule.:
A structure containing an array of seven time-value pairs that specify the daily schedule for Sunday; unused time-value pairs have an invalid value (31) for the hour; if two time-value pairs specify the same time, the first with a valid output value is used.
|
Member Number:
| 7 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
|
0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0
|
|
cpScheduleMonday | Monday schedule.:
A structure containing an array of seven time-value pairs that specify the daily schedule for Monday; unused time-value pairs have an invalid value (31) for the hour; if two time-value pairs specify the same time, the first with a valid output value is used.
|
Member Number:
| 1 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
|
0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0
|
|
cpScheduleTuesday | Tuesday schedule.:
A structure containing an array of seven time-value pairs that specify the daily schedule for Tuesday; unused time-value pairs have an invalid value (31) for the hour; if two time-value pairs specify the same time, the first with a valid output value is used.
|
Member Number:
| 2 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
|
0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0
|
|
cpScheduleWednesday | Wednesday schedule.:
A structure containing an array of seven time-value pairs that specify the daily schedule for Wednesday; unused time-value pairs have an invalid value (31) for the hour; if two time-value pairs specify the same time, the first with a valid output value is used.
|
Member Number:
| 3 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
|
0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0
|
|
cpScheduleThursday | Thursday schedule.:
A structure containing an array of seven time-value pairs that specify the daily schedule for Thursday; unused time-value pairs have an invalid value (31) for the hour; if two time-value pairs specify the same time, the first with a valid output value is used.
|
Member Number:
| 4 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
|
0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0
|
|
cpScheduleFriday | Friday schedule.:
A structure containing an array of seven time-value pairs that specify the daily schedule for Friday; unused time-value pairs have an invalid value (31) for the hour; if two time-value pairs specify the same time, the first with a valid output value is used.
|
Member Number:
| 5 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
|
0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0
|
|
cpScheduleSaturday | Saturday schedule.:
A structure containing an array of seven time-value pairs that specify the daily schedule for Saturday; unused time-value pairs have an invalid value (31) for the hour; if two time-value pairs specify the same time, the first with a valid output value is used.
|
Member Number:
| 6 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
|
0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 OC_OCCUPIED 0
|
|
cpOccBehavior | Occupancy behavior.: Specifies mapping of scheduled occupancy values to primary occupancy states based on local occupancy inputs.
|
Member Number:
| 8 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
| OC_OCCUPIED OC_OCCUPIED OC_OCCUPIED OC_OCCUPIED OC_OCCUPIED |
|
cpMaxSendTime | Maximum send time.: The maximum period of time between consecutive transmissions of the four primary and secondary occupancy values (heartbeat); the value 0 disables the heartbeat.
|
|
cpMinSendTime | Minimum send time.: The minimum period of time between consecutive transmissions of the four primary and secondary occupancy values (throttle); the value 0 disables the throttle.
|
|
cpObjMajVer | Functional block implementation major version number.:
The major version of the functional block implementation. It may be used to identify compatibility of programs with the functional block. For example, if support for new features and functions are added to the functional block, a network tool can use this CP to detect that the functional block is an older version that does not support the new features, and a firmware upgrade is required before this program may be downloaded.
|
Member Number:
| 15 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Flags:
| constant | Array:
| not permitted | Default:
| 0 |
|
cpObjMinVer | Functional block implementation minor version number.:
The minor version of the functional block. It may be used to identify the version of the functional block, so that a configuration tool can present relevant information to a user. The Minor Version of the functional block is used to distinguish version changes that do not affect compatibility. For example, if a functional block has some minor behavioral changes such as range checking added, the tool can decide whether or not to warn the user about this potential issue. Any changes that affect compatibility of programs require a change to the Major version CP.
|
Member Number:
| 16 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Flags:
| device specific, constant | Array:
| not permitted | Default:
| 0 |
|
cpScheduleException | Scheduled exception event.:
Specifies a scheduled event to override a daily schedule. This input is the fourth highest priority override after the Manual Override, Exception Override, and Local Occupancy inputs. It overrides the daily schedule and the Scheduled Vacation/Holiday Event input.
|
Member Number:
| 10 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
| MN_EVERY_MONTH DM_EVERY_DAY 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 |
|
cpScheduleHoliday | Holiday or vacation schedule.:
Specifies a scheduled vacation or holiday event to override a daily schedule. This input is the lowest priority override after the Manual Override, Exception Override, Local Occupancy, and Exception Schedule inputs. It overrides the daily schedule.
|
Member Number:
| 11 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
| MN_EVERY_MONTH DM_EVERY_DAY 0 0 0 0 0 0 0 OC_OCCUPIED 0 0 0 0 0 0 0 0 |
|
cpRandomizationInterval | Randomization interval.:
Specifies an interval around a scheduled time that is used by a scheduler to calculate a random event time. Used to reduce simultaneous startup and shutdown of many devices by multiple schedulers.
|
Member Number:
| 12 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
| 0,0 0,0 |
|
cpSchedulerOptions | Scheduler options.:
Specifies optional features implemented by this scheduler; all Simple Schedulers support time-of-day occupancy scheduling; support for a general-purpose output and sunrise-sunset relative scheduling is optional.
|
Member Number:
| 17 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
| 0 0 0 0 |
|
cpOccThresholds | Occupancy thresholds.: Specifies the minimum number of occupancy sensors that must report the same value to override a scheduled output value.
|
|
cpOccTimeout | Occupancy maximum receive time.:
The maximum period of time that may expire with no updates from an individual source address that reported occupancy before the value is assumed to be unoccupied. A zero value disables occupancy fan-in.
|
Member Number:
| 20 |
Base type:
| |
Applies to
| nvoSchedValue | Array:
| not permitted | Default:
| 0,0 |
|
Optional Configuration Properties |
cpSunriseTime | Sunrise time.:
Time used for sunrise-relative scheduling; must be implemented as a configuration network variable; only the time fields are used for scheduling--the date fields indicate the date used for the configured time.
|
Member Number:
| 18 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
| 0 0 0 0 0 0 |
|
cpSunsetTime | Sunset time.:
Time used for sunset-relative scheduling; must be implemented as a configuration network variable; only the time fields are used for scheduling--the date fields indicate the date used for the configured time.
|
Member Number:
| 19 |
Base type:
| |
Applies to
| SFPTschedulerSimple | Array:
| not permitted | Default:
| 0 0 0 0 0 0 |
|