Zum |
public sealed class ZumWiredRoomInterface : IParentInformation, ILightLoadOverrideControl
The ZumNetBridgeRoomZumWiredRoomInterface type exposes the following members.
| Name | Description | |
|---|---|---|
| AlternateOccupancyScene | Property to recall the occupancy scene. | |
| AlternateOccupancySceneFeedback |
Property to indicate that the occupancy scene is recalled.
This property will trigger ZumRoomInterfaceChange event with AlternateOccupancySceneFeedbackEventId. | |
| AlternateOccupancyVacancyScenesEnabledFeedback |
Property to indicate if the alternate occupancy and vacancy scenes are enabled.
true: occupancy and vacancy scenes are enabled; false; occupancy and vacancy scenes are not enabled This property will trigger ZumRoomInterfaceChange event with AlternateOccupancyVacancyScenesEnabledEventId. | |
| AlternateVacancyScene | Property to recall the vacancy scene. | |
| AlternateVacancySceneFeedback |
Property to indicate that the vacancy scene is recalled.
This property will trigger ZumRoomInterfaceChange event with AlternateVacancySceneFeedbackEventId. | |
| ApplicationOperationSuspendedFeedback |
Property to indicate that Room Operation is suspended.
true: Room Operation suspended; false: Room Operation not suspended
When Room Operation is suspended, any Application currently connected to the Room will be disconnected and
Keypads will not attempt to control lights during addressing operations.
This property will trigger ZumRoomInterfaceChange event with ApplicationOperationSuspendedEventId. | |
| AutoOffTime | Property to set the auto off time in minutes. | |
| AutoOffTimeFeedback |
Property to report the auto off time in minutes.
This property will trigger ZumRoomInterfaceChange event with AutoOffTimeFeedbackEventId. | |
| AutoOffTimerEnabledFeedback |
Property to indicate if the auto off timer is enbled.
true: auto off timer is enabled; false: auto off timer is disabled This property will trigger ZumRoomInterfaceChange event with AutoOffTimerEnabledEventId. | |
| BluetoothPinAcceptanceFeedback |
Property to indicate, if Bluetooth PIN is of 4 digit or 6 digit.
This property will trigger ZumRoomInterfaceChange event with BluetoothPinAcceptanceFeedbackEventId. | |
| BluetoothPinAlertFeedback |
Property to indicate the bluetooth pin alerts.
This property will trigger ZumRoomInterfaceChange event with BluetoothPinAlertFeedbackEventId. | |
| BluetoothPinFeedback |
Property to report the current Bluetooth PIN.
This property will trigger ZumRoomInterfaceChange event with BluetoothPinFeedbackEventId. | |
| BluetoothPinType | Obsolete. Property to set the Bluetooth PIN type, 4 digit or 6 digit BLE pin. | |
| BluetoothPinTypeFeedback |
Property to indicate, if Bluetooth PIN is of 4 digit or 6 digit BLE pin.
This property will trigger ZumRoomInterfaceChange event with BluetoothPinTypeFeedbackEventId. | |
| BluetoothPinV2Feedback |
Property to return the current six digit bluetooth pin.
This property will trigger ZumRoomInterfaceChange event with BluetoothPinV2FeedbackEventId. | |
| ConfigurationApplicationConnectedFeedback |
Property to indicate if the room is connected to the ZUM application for configuration.
true: room connected to ZUM application for configuration; false: room not connected to ZUM application for configuration This property will trigger ZumRoomInterfaceChange event with ConfigurationApplicationConnectedEventId. | |
| CurrentDaylightLevelFeedback |
Property to report the current daylight level.
This property will trigger ZumRoomInterfaceChange event with CurrentDaylightLevelFeedbackEventId. | |
| CurrentRoomNameFeedback |
Property to return the current room name.
This property will trigger ZumRoomInterfaceChange event with CurrentRoomNameFeedbackEventId. | |
| DaylightingEnabledFeedback |
Property to indicate if Scene1 and Day-lighting is enabled.
This property will trigger ZumRoomInterfaceChange event with DaylightingEnabledEventId. | |
| DesiredBluetoothPin | Property to set the desired Bluetooth PIN. | |
| DesiredBluetoothPinType | Property to set the desired Bluetooth PIN type, 4 digit or 6 digit BLE pin. | |
| DesiredBluetoothPinV2 | Property to set the six digit bluetooth pin. | |
| DeviceAlertsFeedback |
Property to indicate that the ZUM device with fault codes.
This property will trigger ZumRoomInterfaceChange event with DeviceAlertsFeedbackEventId. | |
| DeviceListFeedback |
Property to get the collection of devices that are communicating with the network.
For the device info refer ZummeshNetbridgeDeviceInfo class. The BaseEvent event will trigger with DeviceListFeedbackEventId. | |
| DeviceThisInterfaceIsOn | Returns the ZumNetJBoxDali or ZumNetJBoxDaliLegacy device the ZumNetBridgeRoomZumWiredRoomInterface is on. | |
| DimmerFaultsPresentFeedback |
Property to indicate that the dimmer faults are present.
This property will trigger ZumRoomInterfaceChange event with DimmerFaultsPresentFeedbackEventId. | |
| EnableLoadShed |
Property to enable or disable load shedding mode for all devices in the room.
true: load shedding enabled; false: load shedding disabled | |
| ExportIdFeedback |
Property to set the export ID. Used by Hub Macros.
This is a string that can carry a command (request) to the HUB from the room. These are triggered by an event in the room, most likely a key press. It is a string so that the request can be understood by the programmer while looking at the messages. This property will trigger ZumRoomInterfaceChange event with ExportIdFeedbackEventId. | |
| FirmwareUpdateStatusFeedback |
Property to indicate the firmware upgrade status.
true: firmware upgrade is successful; false: firmware upgrade failed This property will trigger ZumRoomInterfaceChange event with FirmwareUpdateStatusEventId. | |
| FloorIdFeedback |
Property to return the floor ID.
This property will trigger ZumRoomInterfaceChange event with FloorIdFeedbackEventId. | |
| InExternalOverrideFeedback |
Indicates if the device is in external override mode.
From Override wire on Zum Wired local bus. The OverrideEventHandler event will trigger with External. | |
| InManualOverrideFeedback |
Indicates if the device is in manual override mode.
Lock all lights on (like override signal on Zum Wired local bus). The OverrideEventHandler event will trigger with Manual. | |
| LoadControllerFirmwareLoadingSuspendedFeedback |
Property to indicate if the Load controlller firmware loading is suspended.
true: Load controller firmware loading is suspended; false: Load controller firmware loading is not suspended This property will trigger ZumRoomInterfaceChange event with LoadControllerFirmwareLoadingSuspendedEventId. | |
| LoadShedMaximumLevel | Property to set the load shed maximum level. | |
| LocalScheduleConfiguredFeedback |
Property to indicate, if local scheduling is configured on this room.
/// This property will trigger ZumRoomInterfaceChange event with LocalScheduleConfiguredEventId. | |
| LocalSchedulingEnabledFeedback |
Property to indicate, if local scheduling is enabled on this room.
/// This property will trigger ZumRoomInterfaceChange event with LocalSchedulingEnabledEventId. | |
| MissingDevicesFeedback |
Property to get the collection of devices that have disappeared from the network.
For the device info refer ZummeshNetbridgeDeviceInfo class. The BaseEvent event will trigger with MissingDevicesFeedbackEventId. | |
| NumberOfDevicesFeedback |
Property to report the number of devices in room.
This property will trigger ZumRoomInterfaceChange event with NumberOfDevicesFeedbackEventId. | |
| OccupancySensorEnabledFeedback |
Property to indicate if the occupancy sensor is enabled or not.
true: occupancy sensor enabled; false: occupancy sensor disabled This property will trigger ZumRoomInterfaceChange event with OccupancySensorEnabledEventId. | |
| Parent | The parent that a ZumNetBridgeRoomZumWiredRoomInterface object was added to. | |
| PlugStatusFeedback |
Property to indicate the plug status.
true: plug is on; false: plug is off This property will trigger ZumRoomInterfaceChange event with PlugStatusEventId. | |
| RoomConfigurationChangedFeedback |
Property to indicate that the ZUM application changed the room's configuration.
true: ZUM application changed the room's configuration; false: ZUM application did not change the room's configuration This property will trigger ZumRoomInterfaceChange event with RoomConfigurationChangedEventId. | |
| RoomDeviceFeedbackEnabledFeedback |
Property to indicate if the room device feedback is enabled.
true: room device feedback is enabled; false: room device feedback is disabled This property will trigger ZumRoomInterfaceChange event with RoomDeviceFeedbackEnabledEventId. | |
| RoomId | Property to set the room Id, unique number given by the app. | |
| RoomIdFeedback |
Property to return the room ID.
This property will trigger ZumRoomInterfaceChange event with RoomIdFeedbackEventId. | |
| RoomIdsMismatchFeedback |
Property to indicate that the room ids are mismatched.
This property will trigger ZumRoomInterfaceChange event with RoomIdsMismatchFeedbackEventId. | |
| RoomIsOnFeedback |
Property to indicate if room is on.
This property will trigger ZumRoomInterfaceChange event with RoomIsOnEventId. | |
| RoomOccupiedFeedback |
Property to indicate if the room is occupied.
This property will trigger ZumRoomInterfaceChange event with RoomOccupiedEventId. | |
| SceneActiveFeedback |
Collection of scene active feedbacks.
Scene active feedback indicates that the corresponding acene is active. This property will trigger ZumRoomInterfaceChange event with SceneActiveEventId and Index will indicate the index into this collection. | |
| SetFloorId | Property to set the floor ID. | |
| SetRoomName | Property to set the room name. | |
| SetZoneId | Property to set the zone ID. | |
| SuspendApplicationOperation | Property to suspend Room Operation. true: suspend Room Operation; false: continue Room Operation When Room Operation is suspended, any Application currently connected to the Room will be disconnected and Keypads will not attempt to control lights during addressing operations. | |
| UserSpecifiedObject | Can be assigned anything that user wants. | |
| VicinityBindingEnabledFeedback |
Property to indicate if the vicinity occupancy binding logic is enabled.
true: vicinity occupancy binding logic is enabled; false: vicinity occupancy binding logic is disabled This property will trigger ZumRoomInterfaceChange event with VicinityBindingEnabledEventId. | |
| ZoneIdFeedback |
Property to return the zone ID.
This property will trigger ZumRoomInterfaceChange event with ZoneIdFeedbackEventId. |
| Name | Description | |
|---|---|---|
| ActivateScene | This method triggers the load to ramp to the desired saved scene levels. (This will be for scene X = 1 to 16). | |
| CancelUpdate | Method to cancel the update. | |
| ClearRoomConfigurationChanged | Method to clear the RoomConfigurationChangedFeedback property value. | |
| DisableAlternateOccupancyVacancyScenes | Method to disable the alternate occupancy and vacancy scenes. | |
| DisableAutoOffTimer | Method to disable the auto off timer. | |
| DisableDaylighting | Method to disable daylighting. | |
| DisableLocalScheduling | Method to disable local scheduling on this room. | |
| DisableOccupancySensor | Method to disable occupancy sensor. | |
| DisableRoomDeviceFeedback | Method to disable room device feedback. | |
| DisableVicinityBinding | Method to disable the vicinity occupancy binding logic. | |
| EnableAlternateOccupancyVacancyScenes |
Method to enable the alternate occupancy and vacancy scenes.
Allowing a second set of Occupied and Vacant illumination values. Perhaps to be used when the space is being maintained rather than for its normal use. | |
| EnableAutoOffTimer |
Method to enable the auto off timer.
When enabled, turning lights on starts a timer. Room will turn lights off when timer expires. Timer is retrigger-able by any event that would turn a light on. Ex. Occupancy sensor. Room flashes lights for "10 minutes" warning. Time in minutes | |
| EnableLocalScheduling | Method to enable local scheduling on this room. | |
| EnableOccupancySensor | Method to enable occupancy sensor. | |
| EnableRoomDeviceFeedback | Method to enable room device feedback. | |
| EnableVicinityBinding |
Method to enable the vicinity occupancy binding logic.
Vicinity Binding refers to the load controller using a third Occupancy/Vacancy sensor input. Rather than Occupied or Vacant, Vicinity will mean someone is nearby (in the vicinity). When enabled, the load controller can use this input to determine that someone its zone is unoccupied, but someone is in a nearby zone. The load controller can then choose to turn on at a lower level, just to provide a feeling that there is not a wall of darkness surrounding the occupant. In some films you see corridors where the illumination follows the characters as they walk, the ones at the extreme end of that corridor of light will be triggered by their vicinity sensors rather than direct occupation. | |
| EnterManualOverride | Enter manual override mode. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| ExitManualOverride | Exit manual override mode. | |
| GetAlertList | Method to get the DeviceAlertsFeedback property value. | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| PlugOff | Method to set the plug to off. | |
| PlugOn | Method to set the plug to on. | |
| ResetBluetoothPinBackOffTimer | Method to reset bluetooth holdoff timer that keeps the user from attempting multiple back to back PIN guesses. The timeout increases based on the number of consecutive incorrect PIN attempts. | |
| ResumeLoadControllerFirmwareLoading | Method to resume the Load controller firmware loading. | |
| RoomAllOff | Method to set all loads in the room to off. | |
| SaveBluetoothPin | Method to save Bluetooth PIN. Between the 4-digit and the 6-digit PIN, the FW will only save the one currently specified by BluetoothPinType. | |
| SuspendLoadControllerFirmwareLoading | Method to suspend the Load controller firmware loading. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Name | Description | |
|---|---|---|
| OverrideEventHandler |
Event triggered when the ZumNetBridgeRoomZumWiredRoomInterface reports Override sig information to the Control System.
Valid event IDs are available in eOverrideEvents. | |
| ZumRoomInterfaceChange | Event triggered when a feedback has changed for this ZumNetBridgeRoomZumWiredRoomInterface. |