Click or drag to resize

InetsIoexDoorBatt Class

Battery operated compact infiNET EX Wireless door sensor.

This class will trigger BaseEvent event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.GeneralIOInetsIoexDoorBatt

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

The InetsIoexDoorBatt type exposes the following members.

Constructors
 NameDescription
Public methodInetsIoexDoorBatt Constructor to generate a new InetsIoexDoorBatt that is attached to the specified RF gateway.
Top
Properties
 NameDescription
Public propertyBatteryLowFeedback Property to indicate that the door sensor battery level is low. 'true' = battery level is low; 'false' = battery level is not low

This property will trigger BaseEvent event with BatteryLowEventId.

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 propertyDoorClosedFeedback Property to indicate that the door is closed. 'true' = door closed; 'false' = door not closed

This property will trigger BaseEvent event with DoorClosedEventId.

Public propertyDoorOpenedFeedback Property to indicate that the door is opened. 'true' = door opened; 'false' = door not opened

This property will trigger BaseEvent event with DoorOpenedEventId.

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 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)
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
Fields
 NameDescription
Public fieldStatic memberBatteryLowEventId The state of BatteryLowFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDoorClosedEventId The state of DoorClosedFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDoorOpenedEventId The state of DoorOpenedFeedback has changed.

The BaseEvent event will trigger for this event id.

Top
Example
C#
static InetsIoexDoorBatt _device;

public ControlSystemInetsIoexDoorBatt()
{
    //Register console commands
    CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a INETS-IOEX-DOOR-BATT CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
}

public void CreateDeviceCmd(String args)
{
    //For internal gateway, this will work only with MC3 but not for RMC3 or CP3
    _device = new InetsIoexDoorBatt(0x3, ControllerRFGatewayDevice);

    _device.BaseEvent += DeviceEventHandler;
    _device.Register();
}

// Method to handle sig change events for INETS-IOEX-DOOR-BATT infiNET EX Door Sensor Device.
static void DeviceEventHandler(GenericBase device, BaseEventArgs args)
{
    if (args.EventId == InetsIoexDoorBatt.DoorClosedEventId)
    {
        CrestronConsole.PrintLine("{0} Door Closed Event Occurred", device.ToString());
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also