Shade |
public sealed class ShadeGroup : DeviceGroup<ShadeBase>
The ShadeGroup type exposes the following members.
| Name | Description | |
|---|---|---|
| ShadeGroup | Creates an instance of a shade group. Group ID can be from 1 to 252. Group IDs must be unique per transport. An exception will be thrown when an add is attempted if there is already a group that has this groups's ID and a shade and the shade is on the same transport as the shade that is being added to this group. The exception will be thrown during the add attempt. |
| Name | Description | |
|---|---|---|
| Count |
Gets the number of objects in the dictionary.
(Inherited from DeviceGroupT) | |
| Disposed |
Property to indicate if the device group has been disposed.
(Inherited from DeviceGroupT) | |
| ID |
Group ID.
(Inherited from DeviceGroupT) | |
| Lower | Moves shades towards the lower limit or closed position. | |
| Raise | Raises shades towards the upper limit or open position. | |
| SetPosition | Sends all shades that are in this group to a particular position at the same time. Will send the shades to a particular position where 0x0000 is the lower limit and 0xffff corresponds to the upper limit. |
| Name | Description | |
|---|---|---|
| Add |
Adds a device to this group.
All devices added must be on the same transport (e.g. a controller's Cresnet interface, a controller's RF gateway, an RF gateway).
The first device added (either after the device group is created or after all devices have been removed from the group) determines
the the group designated transport that all other added devices must be on.
Devices must implement the appropriate IGroupableDevice interface (e.g. IGroupableDevice for a ShadeGroup)
for device group.
Devices cannot be added to separate groups that have the same group ID number.
No devices can be at ID 255 on the group designated transport.
There can be up to 252 groups on each transport.
Devices must be registered after they are added to group.
Group ID numbers must be unique per transport. For example if two groups are created with the ID 5 and then one of two different devices
that are on the same transport are added added to each group an exception will be thrown with the second add attempt because it will be detected
that there is already a group at ID 5 on the transport. At that point the group can either be disposed or another device that is on a different transport
can be added to it.
(Inherited from DeviceGroupT) | |
| Clear |
Clears group.
(Inherited from DeviceGroupT) | |
| Close | Closes all shades that are in this group at the same time. Will move the shades to the lower limit. | |
| Contains(T) |
Determines if this collection contains the specified value.
(Inherited from DeviceGroupT) | |
| Contains(UInt32) |
Determines if this collection contains the specified key.
(Inherited from DeviceGroupT) | |
| Dispose |
Dispose of the device group.
(Inherited from DeviceGroupT) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Device group destructor.
(Inherited from DeviceGroupT) | |
| GetEnumerator |
Enumerator for the Crestron Collection.
(Inherited from DeviceGroupT) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| Open | Opens all shades that are in this group at the same time. Will move the shades to the upper limit. | |
| Remove |
Removes a device from the device group.
(Inherited from DeviceGroupT) | |
| Stop | Stops all shades that are in this group at the same time. Will stop all shades movement. | |
| ToString |
Returns the group type and group ID.
(Inherited from DeviceGroupT) |