Click or drag to resize

CenIoRy104 Class

Crestron external standalone Relays card that provides low-voltage relay control interfaces for remote devices such as garage door openers, sensors, and motorized screens. It includes four isolated relays and communicates with the control system network via Ethernet.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.GeneralIOCenIoRy
        Crestron.SimplSharpPro.GeneralIOCenIoRy104

Namespace: Crestron.SimplSharpPro.GeneralIO
Assembly: Crestron.SimplSharpPro.GeneralIO (in Crestron.SimplSharpPro.GeneralIO.dll) Version: 2.21.121
Syntax
C#
public sealed class CenIoRy104 : CenIoRy

The CenIoRy104 type exposes the following members.

Constructors
 NameDescription
Public methodCenIoRy104 Constructor to generate a new CenIoRy104 object.
Top
Properties
 NameDescription
Public propertyConnectedIpList 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)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfRelayPorts Number of relay ports this device supports.
(Inherited from CenIoRy)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertyRelayPorts Collection of relay ports on the device.
(Inherited from CenIoRy)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Protected propertyXioEndpointStubSIMPLDevice 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)
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister 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)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventIpInformationChange 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)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Example
C#
static CenIoRy104 _ry4;
public ControlSystemCenIoRy4()
{
    //Register console commands
    CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDeviceRelay", "This is a CEN-IO-RY-104 CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
    CrestronConsole.AddNewConsoleCommand(OpenRelayCmd, "OpenRelay", "This is a OpenRelay command", ConsoleAccessLevelEnum.AccessOperator);
    CrestronConsole.AddNewConsoleCommand(RegisterCmd, "RegisterRelay", "This is a Register command to register with device.", ConsoleAccessLevelEnum.AccessOperator);
}

//Function to create the CEN-IO-RY-104 device
public void CreateDeviceCmd(String args)
{
    _ry4 = new CenIoRy104(0x19, this);
    _ry4.Register();
    CrestronConsole.ConsoleCommandResponse("{0} device successfully registered\r\n", _ry4.ToString());
    _ry4.RelayPorts[1].StateChange += RelayStateChangeEventHandler;
}

//Function to register relay ports.
public void RegisterCmd(String args)
{
    _ry4.RelayPorts[Convert.ToUInt32(args)].Register();
    CrestronConsole.ConsoleCommandResponse("Relay port is registered .\r\n");
}

//Function to make relay open.
public void OpenRelayCmd(String args)
{
    _ry4.RelayPorts[Convert.ToUInt32(args)].Open();
    CrestronConsole.ConsoleCommandResponse("Relay port {0} current state is: {1} \r\n", Convert.ToUInt32(args), _ry4.RelayPorts[Convert.ToUInt32(args)].State);
}

//Function to handle the relay state change events
static void RelayStateChangeEventHandler(Relay relay, RelayEventArgs args)
{
    CrestronConsole.PrintLine("Relay State changed for port {0}, to {1}", 1, _ry4.RelayPorts[1].State);
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also