Status |
This class will trigger BaseEvent event.
public sealed class StatusSign : GenericDevice
The StatusSign type exposes the following members.
| Name | Description | |
|---|---|---|
| StatusSign(UInt32, CrestronControlSystem) | Constructor to generate a new StatusSign device. | |
| StatusSign(UInt32, IDeviceBranch) | Constructor to generate a new StatusSign device. |
| Name | Description | |
|---|---|---|
| ConnectedIpList |
A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID.
This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null.
If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected.
The order of items in this list is not guaranteed.
(Inherited from GenericDevice) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| Leds |
Collection of StatusSignLed objects for StatusSign.
This collection contains one of each LED (Red, Green, Blue) and to set the color of the sign the user must set the Control value to true of each LED and then the Brightness shall be set to required value.
This property will trigger BaseEvent event with event IDs defined in StatusSign. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice |
The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the
correct place in hierarchy.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
Unregister this device with the system. This function can not be called from the device's own SigChange event handler.
On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline. (Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| IpInformationChange |
Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device.
This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| LedBlinkTimeFeedbackEventId |
The value of BlinkTimeFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| LedBrightnessFeedbackEventId |
The value of BrightnessFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| LedControlFeedbackEventId |
The state of ControlFeedback has changed.
The BaseEvent event will trigger for this event id. |
static StatusSign statusSignDevice; public ControlSystemCSign() { //Register console commands CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a StatusSign CreateDevice command", ConsoleAccessLevelEnum.AccessOperator); CrestronConsole.AddNewConsoleCommand(SetControlOnCmd, "SetControlOn", "This is a StatusSign SetControlOn command", ConsoleAccessLevelEnum.AccessOperator); } // Method to handle StatusSign top level sig change events. static void StatusSignEventHandler(GenericBase device, BaseEventArgs args) { if (args.EventId == StatusSign.LedControlFeedbackEventId) { CrestronConsole.PrintLine("{0} Led Control Feedback Event received, Control State is {1}\r\n", statusSignDevice.Leds[(uint)args.Index].Color, statusSignDevice.Leds[(uint)args.Index].ControlFeedback.BoolValue); } } // Method to create a StatusSign device. public void CreateDeviceCmd(String args) { //Initialize the StatusSign device statusSignDevice = new StatusSign(0x18, this); statusSignDevice.BaseEvent += StatusSignEventHandler; //Register the StatusSign with the Control system statusSignDevice.Register(); } // Method to set the specified LED control on. // How to use the command: SetControlOn 1-3 To set control to on public void SetControlOnCmd(String args) { uint i = Convert.ToUInt32(args); if ((i > 0) && (i <= 3)) { statusSignDevice.Leds[i].Control.BoolValue = true; CrestronConsole.PrintLine("{0} device LED {1} Control state is {2}\r\n", statusSignDevice.ToString(), args, statusSignDevice.Leds[i].Control.BoolValue); } }