System Features

Identification Strings Feature (0x001)

The Identification Strings Feature provides pointers to registers containing strings that describe the device.

Identification Strings

Feature ID

0x001

Version

0x001

(0.1)

Pointer Count

7

Bootstrap ID

0x00100107

(Max pointers)

Pointer 0

String

Manufacturer Name

Pointer 1

String

Device Model Name

Pointer 2

String

Device Version

Pointer 3

String

Serial Number

Pointer 4

String

Manufacturer Info

Pointer 5

String

User Defined Name

Pointer 6

String

Device Webpage (URL)

A string pointer points to the first register of a variable-length, null-terminated string.

Manufacturer Name

Typically static.

Device Model Name

Typically static. May be used for mDNS service discovery.

Device Version

Typically static.

Serial Number

Should be unique per model. May be used for mDNS.

Manufacturer Info

Typically static.

User Defined Name

User-writable, stored in non-volatile memory. Must hold at least 16 characters (including null terminator).

Device Webpage

URL to documentation or manual.

Register Detail Embedded File Feature (0x002)

An EEVideo device may offer structured metadata files containing additional information on the device registers. These files are stored on the device and are typically compressed.

Embedded Register Detail File

Feature ID

0x002

Version

0x001

(0.1)

Pointer Count

1

Bootstrap ID

0x00200101

Pointer 0

File

File Length / Name / Contents

Register Detail File

The pointer points to the first of a set of registers. The number of registers depends on the name string length and the file content.

Register Detail File Registers

Offset 0

4 Bytes

Length of file in bytes (excluding length and name)

Offset 1

String

File name and extension

Offset n+1

Data

File contents

The format of the file is determined by its extension (detailed in a future section).

Register Detail File URL Feature (0x003)

Register Detail Files may also be made available at a URL.

Embedded Register Detail File URL

Feature ID

0x003

Version

0x001

(0.1)

Pointer Count

1

Bootstrap ID

0x00300101

Pointer 0

String

URL for register detail file

URL for Register Detail File

A string containing a full URL where the register detail file can be downloaded.

NVM Backup Feature (0x0??)

The NVM Backup Control feature provides pointers to registers that store and recall specific blocks of registers to and from non-volatile memory included in the device.

TBD

Command Script Feature (0x0??)

The Command Script Feature provides pointers to registers that allow building and executing lists of register commands. These lists may be used for initialization or mode switching with a single register write.

TBD

Watchdog / Heartbeat Feature (0x0??)

The Watchdog / Heartbeat Feature provides pointers to registers with timer functionality to indicate the device is functioning properly and reset the device if timeouts occur or communication with the host is lost.

TBD

Reset / Sleep Feature (0x0??)

The Reset / Sleep Feature provides pointers to registers that reset internal device processes and put the device into reduced-functionality, lower-power modes.

TBD

Unsolicited Response Feature (0x0??)

The Unsolicited Response Feature provides pointers to registers that allow the device to deliver unsolicited read response packets to a host when specified events occur.

TBD

Write Enable Feature (0x0??)

TBD

Custom features may be implemented, included in the Feature Manifest, and further defined in Register Detail Files.

Custom features must use a Feature ID value ≥ 0x800 and < 0x900 (included in their Bootstrap ID).