St |
public sealed class StIo : GenericDevice, IRelayPorts, IDigitalInputPorts
The StIo type exposes the following members.
| Name | Description | |
|---|---|---|
| StIo(UInt32, CrestronControlSystem) | Constructor to create a new StIo object. | |
| StIo(UInt32, IDeviceBranch) | Constructor to create a new StIo object. |
| 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) | |
| DigitalInputPorts | Collection of digital input ports on the device. | |
| 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) | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| NumberOfDigitalInputPorts | Number of digital input ports this device supports. | |
| NumberOfRelayPorts | Number of relay ports this device supports. | |
| 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) | |
| RelayPorts | Collection of relay ports on the device. | |
| 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) |
static StIo myStIo; public ControlSystemStcom() { CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a ST-IO CreateDevice command", ConsoleAccessLevelEnum.AccessOperator); CrestronConsole.AddNewConsoleCommand(OpenRelayCmd, "OpenRelay", "This is a ST-IO OpenRelay command", ConsoleAccessLevelEnum.AccessOperator); CrestronConsole.AddNewConsoleCommand(CloseRelayCmd, "CloseRelay", "This is a ST-IO CloseRelay command", ConsoleAccessLevelEnum.AccessOperator); } //Function to create the device object. public void CreateDeviceCmd(String args) { myStIo = new StIo(0x17, this); myStIo.Register(); CrestronConsole.ConsoleCommandResponse("{0} device successfully registered.\r\n", myStIo.ToString()); for (uint i = 1; i <= 4; i++) { myStIo.DigitalInputPorts[i].StateChange += DigitalInputStateChangeEventHandler; } } //Function to handle Digital Input state change for ST-IO. public void DigitalInputStateChangeEventHandler(DigitalInput digitalInput, DigitalInputEventArgs args) { CrestronConsole.PrintLine("Digital Input State changed for port {0}, to {1}", 1, myStIo.DigitalInputPorts[1].State); CrestronConsole.PrintLine("Digital Input State changed for port {0}, to {1}", 2, myStIo.DigitalInputPorts[2].State); } //Function to close a relay port. public void CloseRelayCmd(String args) { myStIo.RelayPorts[Convert.ToUInt32(args)].Close(); CrestronConsole.ConsoleCommandResponse("Relay port close state {0}.\r\n", myStIo.RelayPorts[Convert.ToUInt32(args)].State); } //Function to open a relay port. public void OpenRelayCmd(String args) { myStIo.RelayPorts[Convert.ToUInt32(args)].Open(); CrestronConsole.ConsoleCommandResponse("Relay port open state {0}.\r\n", myStIo.RelayPorts[Convert.ToUInt32(args)].State); }