GeneralInformation

The GeneralInformation property defines certain metadata about the controlled device. The following properties are available and must be set correctly.

GeneralInformation Properties

Property Type Use
DeviceType String

The device type. The following values are accepted:

  • Flat Panel Display
  • Projector
  • Video Server
  • A/V Receiver
  • Bluray Player
  • Cable Box
Manufacturer String The device manufacturer.
BaseModel String The device model that the driver was written to support.
VersionDate DateTime The date and time when the driver was last changed.
DriverVersion String The driver version. A maximum of four version components (separated by periods) are supported, each in the range of 0–65534 (inclusive). The first component must be the major version and should be incremented whenever a breaking change is made to the driver. The semantics of the remaining components are up to the driver developer. Crestron drivers use the second component to encode both the minor and patch version, and they use the third component for the build number.
SdkVersion String The device type library version that is used. This value must be the first three octets of that library version number.
Description String A description of the device.
Guid GUID No longer used. Use an empty GUID.
SupportedSeries List<string> A list of device series supported by the driver.
SupportedModel List<string> A list of device models supported by the driver.
Developer1,2 Object

Information regarding the driver developer:

  • Company: The driver developer company name (string)
  • Contact: The driver developer support contact (string)
  • Email: The email address of the driver developer support contact (string)
  • Website: The driver developer company website (string)
  • PhoneNumber: The driver developer company phone number (string)
DependencyGroup1,2 String

An identifier that is unique to a driver developer company and a group of drivers. Informs the application whether there are any shared dependencies amongst drivers, such as static data. Drivers with the same DependencyGroup will be grouped into the same process, if possible.

If a driver does not depend on any shared static data that requires it to run in the same process as another, the DependencyGroup must be set to an empty string. Do not set it to null or leave it unspecified.

Current dependency groups are used in Crestron Home to denote if a driver can be used as hot swappable. For more information, refer to Inter-Driver Communications.

LicenseRequired Boolean Must be set to true if purchasing a license is required to use the driver.
ExtensionDeviceData Object

Contains Information for Extension Device Drivers (may be omitted for other driver types).

  • IsExtensionDevice (Boolean): Must be set to true if the driver is for an extension device.

1 These properties are available only when using SDK Framework 17 or later, including the ManifestUtility tool from the Crestron Drivers SDK v17 or later.
2 As of SDK Framework 18, the Developer and DependecyGroup properties are mandatory in the driver JSON when using the ManifestUtility tool.