Namespace ColorHug

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

Cmd

Cmd: number

Variables

Const BUFFER_INPUT_CMD

BUFFER_INPUT_CMD: number

Const BUFFER_INPUT_DATA

BUFFER_INPUT_DATA: number

Const BUFFER_OUTPUT_CMD

BUFFER_OUTPUT_CMD: number

Const BUFFER_OUTPUT_DATA

BUFFER_OUTPUT_DATA: number

Const BUFFER_OUTPUT_RETVAL

BUFFER_OUTPUT_RETVAL: number

Const CALIBRATION_DESCRIPTION_LEN

CALIBRATION_DESCRIPTION_LEN: number

Const CALIBRATION_INDEX_CRT

CALIBRATION_INDEX_CRT: number

Const CALIBRATION_INDEX_FACTORY_ONLY

CALIBRATION_INDEX_FACTORY_ONLY: number

Const CALIBRATION_INDEX_LCD

CALIBRATION_INDEX_LCD: number

Const CALIBRATION_INDEX_LED

CALIBRATION_INDEX_LED: number

Const CALIBRATION_INDEX_MAX

CALIBRATION_INDEX_MAX: number

Const CALIBRATION_INDEX_PROJECTOR

CALIBRATION_INDEX_PROJECTOR: number

Const CALIBRATION_MAX

CALIBRATION_MAX: number

Const CALIBRATION_SPECTRAL

CALIBRATION_SPECTRAL: number

Const CALIBRATION_TYPE_ALL

CALIBRATION_TYPE_ALL: number

Const CALIBRATION_TYPE_CRT

CALIBRATION_TYPE_CRT: number

Const CALIBRATION_TYPE_LCD

CALIBRATION_TYPE_LCD: number

Const CALIBRATION_TYPE_LED

CALIBRATION_TYPE_LED: number

Const CALIBRATION_TYPE_PROJECTOR

CALIBRATION_TYPE_PROJECTOR: number

Const CCD_SPECTRAL_RESOLUTION

CCD_SPECTRAL_RESOLUTION: number

Const CMD_BOOT_FLASH

CMD_BOOT_FLASH: number

Boot into to the flash memory.

IN: [1:cmd] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | × ColorHug2 | ✓ | × ColorHug+ | ✓ | × ColorHugALS | ✓ | ×

Const CMD_CLEAR_ERROR

CMD_CLEAR_ERROR: number

Clears any recorded error on the device.

PROTOCOLv2: bRequest: [cmd] wValue: 0x00 wIndex: interface wLength: 0x00 Direction: DEVICE->HOST Data: []

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_ERASE_FLASH

CMD_ERASE_FLASH: number

Erases flash memory before a write is done. Erasing flash can only be done in 1k byte chunks and should be aligned to 1k.

IN: [1:cmd][2:address][2:length] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | × ColorHug2 | ✓ | × ColorHug+ | ✓ | × ColorHugALS | ✓ | ×

Const CMD_GET_ADC_CALIBRATION_NEG

CMD_GET_ADC_CALIBRATION_NEG: number

Gets the value of the Vref- ADC adjustment. vref is a packed float.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:vref]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_ADC_CALIBRATION_POS

CMD_GET_ADC_CALIBRATION_POS: number

Gets the value of the Vref+ ADC adjustment. vref is a packed float.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:vref]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_CALIBRATION

CMD_GET_CALIBRATION: number

Gets the calibration matrix. The description does not have to be NULL terminated.

types is a bitmask which corresponds to:

bit: 0 Can be used with LCD panels 1 Can be used with CRT monitors 2 Can be used with projectors 3 Can be used with LED panels 4-7 Reserved for future use

IN: [1:cmd][2:index] OUT: [1:retval][1:cmd][2*9:matrix_value][1:types][23:description]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_GET_CALIBRATION_MAP

CMD_GET_CALIBRATION_MAP: number

Get the mappings from default calibration type to calibration indexes.

The calibration types are as follows: LCD = 0 CRT = 1 Projector = 2 LED = 3 Custom1 = 4 Custom2 = 5

In the future CustomX may be renamed to another display technology, e.g. e-ink.

IN: [1:cmd] OUT: [1:retval][1:cmd][6*2:types]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_GET_CCD_CALIBRATION

CMD_GET_CCD_CALIBRATION: number

Gets the spectral indexes for the RGB calibration which are values between 0 and %CH_CCD_SPECTRAL_RESOLUTION pointing to the dominant peak for the color. Red is nominally 625nm, green 520nm and blue 465nm.

IN: [1:cmd] OUT: [1:retval][1:cmd][2:red-idx][2:green-idx][2:blue-idx]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_COLOR_SELECT

CMD_GET_COLOR_SELECT: number

Get the color select state.

IN: [1:cmd] OUT: [1:retval][1:cmd][1:color_select]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ✓

Const CMD_GET_DAC_VALUE

CMD_GET_DAC_VALUE: number

Get the DAC value. scale is a packed float, where 1.0f is 3.3V

IN: [1:cmd] OUT: [1:retval][1:cmd][4:value]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_DARK_OFFSETS

CMD_GET_DARK_OFFSETS: number

Get the dark offsets.

IN: [1:cmd] OUT: [1:retval][1:cmd][2:red][2:green][2:blue]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_ERROR

CMD_GET_ERROR: number

Gets any recorded error from the device.

PROTOCOLv2: bRequest: [cmd] wValue: 0x00 wIndex: interface wLength: 0x00 Direction: DEVICE->HOST Data: [1:error][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_FIRMWARE_VERSION

CMD_GET_FIRMWARE_VERSION: number

Gets the firmware version.

IN: [1:cmd] OUT: [1:retval][1:cmd][2:major][2:minor][2:micro]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | ✓ ColorHug2 | ✓ | ✓ ColorHug+ | ✓ | ✓ ColorHugALS | ✓ | ✓

Const CMD_GET_HARDWARE_VERSION

CMD_GET_HARDWARE_VERSION: number

Get the hardware version.

The hardware versions are as follows: 0x00 = Pre-production hardware 0x01 = ColorHug 0x02 = ColorHug2 0x03 = ColorHug+ 0x04 = ColorHugALS 0x05-0x0f = Reserved for future use

IN: [1:cmd] OUT: [1:retval][1:cmd][1:hw_version]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | ✓ ColorHug2 | ✓ | ✓ ColorHug+ | ✓ | ✓ ColorHugALS | ✓ | ✓

Const CMD_GET_ILLUMINANTS

CMD_GET_ILLUMINANTS: number

Get the illuminant state.

IN: [1:cmd] OUT: [1:retval][1:cmd][1:illuminants]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_INTEGRAL_TIME

CMD_GET_INTEGRAL_TIME: number

Gets the integral time.

IN: [1:cmd] OUT: [1:retval][1:cmd][2:integral_time]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ✓

Const CMD_GET_LEDS

CMD_GET_LEDS: number

Get the LED state.

IN: [1:cmd] OUT: [1:retval][1:cmd][1:led_state]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | ✓ | ✓

Const CMD_GET_MEASURE_MODE

CMD_GET_MEASURE_MODE: number

Gets the measurement mode.

IN: [1:cmd] OUT: [1:retval][1:cmd][1:measure_mode]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_GET_MULTIPLIER

CMD_GET_MULTIPLIER: number

Gets the multiplier value.

IN: [1:cmd] OUT: [1:retval][1:cmd][1:multiplier_value]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ✓

Const CMD_GET_OWNER_EMAIL

CMD_GET_OWNER_EMAIL: number

Get User's Email Address

IN: [1:cmd] OUT: [1:retval][1:cmd][60:owner-email]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_OWNER_NAME

CMD_GET_OWNER_NAME: number

Get User's Name

IN: [1:cmd] OUT: [1:retval][1:cmd][60:owner-name]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_PCB_ERRATA

CMD_GET_PCB_ERRATA: number

Gets the board errata value.

IN: [1:cmd] OUT: [1:retval][1:cmd][2:pcb_errata]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_POST_SCALE

CMD_GET_POST_SCALE: number

Get the post XYZ scaling constant. scale is a packed float.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:scale]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_GET_PRE_SCALE

CMD_GET_PRE_SCALE: number

Get the pre XYZ scaling constant. scale is a packed float.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:scale]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_GET_REMOTE_HASH

CMD_GET_REMOTE_HASH: number

Gets the remote hash which is used to get the last profile saved to a public web service.

IN: [1:cmd] OUT: [1:retval][1:cmd][20:sha1_hash]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_GET_SERIAL_NUMBER

CMD_GET_SERIAL_NUMBER: number

Gets the device serial number.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:serial_number]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ✓

Const CMD_GET_TEMPERATURE

CMD_GET_TEMPERATURE: number

Gets the temperature of the sensor in degrees celsius

IN: [1:cmd] OUT: [1:retval][1:cmd][4:temperature]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_LOAD_SRAM

CMD_LOAD_SRAM: number

Load the SRAM from the EEPROM.

PROTOCOLv2: bRequest: [cmd] wValue: 0x00 wIndex: interface wLength: 0x00 Direction: DEVICE->HOST Data: [1:error][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_READ_FLASH

CMD_READ_FLASH: number

Read in raw data from the flash memory.

IN: [1:cmd][2:address][1:length] OUT: [1:retval][1:cmd][1:checksum][1-60:data]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | × ColorHug2 | ✓ | × ColorHug+ | ✓ | × ColorHugALS | ✓ | ×

Const CMD_READ_SRAM

CMD_READ_SRAM: number

Read in raw data from the SRAM memory.

PROTOCOLv1: IN: [1:cmd][2:address][1:length] OUT: [1:retval][1:cmd][1-60:data]

PROTOCOLv2: bRequest: [cmd] wValue: [address-index/64] wIndex: interface wLength: 0x64 Direction: DEVICE->HOST Data: [64:DATA]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_RESET

CMD_RESET: number

Reset the processor.

IN: [1:cmd] OUT: [1:retval][1:cmd] (but with success the device will disconnect)

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | ✓ ColorHug2 | ✓ | ✓ ColorHug+ | ✓ | ✓ ColorHugALS | ✓ | ✓

Const CMD_SAVE_SRAM

CMD_SAVE_SRAM: number

Save the SRAM to the EEPROM.

PROTOCOLv2: bRequest: [cmd] wValue: 0x00 wIndex: interface wLength: 0x00 Direction: DEVICE->HOST Data: [1:error][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SELF_TEST

CMD_SELF_TEST: number

Tests the device by trying to get a non-zero reading from each color channel.

IN: [1:cmd] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | ✓ ColorHug2 | ✓ | ✓ ColorHug+ | ✓ | ✓ ColorHugALS | ✓ | ×

Const CMD_SET_CALIBRATION

CMD_SET_CALIBRATION: number

Sets the calibration matrix.

IN: [1:cmd][2:index][4*9:matrix_value][1:types][23:description] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_SET_CALIBRATION_MAP

CMD_SET_CALIBRATION_MAP: number

Set the calibration type to index map.

IN: [1:cmd][6*2:types] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_SET_CCD_CALIBRATION

CMD_SET_CCD_CALIBRATION: number

Sets the spectral indexes for the RGB calibration.

IN: [1:cmd][2:red-idx][2:green-idx][2:blue-idx] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_COLOR_SELECT

CMD_SET_COLOR_SELECT: number

Set the color select state.

IN: [1:cmd][1:color_select] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ✓

Const CMD_SET_CRYPTO_KEY

CMD_SET_CRYPTO_KEY: number

Sets the 128 bit encyption key for the device.

PROTOCOLv2: bRequest: [cmd] wValue: 0x00 wIndex: interface wLength: 0x00 Direction: DEVICE->HOST Data: [4:key0][4:key1][4:key2][4:key3]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_DAC_VALUE

CMD_SET_DAC_VALUE: number

Set the DAC value. scale is a packed float, where 1.0f is 3.3V

IN: [1:cmd][4:value] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_DARK_OFFSETS

CMD_SET_DARK_OFFSETS: number

Set the dark offsets for use when taking samples when the measure mode is FREQUENCY. When the measure mode is DURATION these values have no effect.

IN: [1:cmd][2:red][2:green][2:blue] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_FLASH_SUCCESS

CMD_SET_FLASH_SUCCESS: number

Sets the result of the firmware flashing. The idea of this command is that the flashing interaction is thus:

Reset()			device goes to bootloader mode

SetFlashSuccess(FALSE)

WriteFlash($data)

ReadFlash($data)	to verify

BootFlash()		switch to program mode

```
SetFlashSuccess(TRUE)
```

The idea is that we only set the success FALSE from the bootoloader to indicate that on booting we should not boot into the program. We can only set the success true from the new program code so as to verify that the new program boots, and can accept HID commands.

IN: [1:cmd][1:success] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | ✓ ColorHug2 | ✓ | ✓ ColorHug+ | ✓ | ✓ ColorHugALS | ✓ | ✓

Different values of success are permitted in each mode.

Const CMD_SET_ILLUMINANTS

CMD_SET_ILLUMINANTS: number

Set the illuminants.

IN: [1:cmd][1:illuminant] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_INTEGRAL_TIME

CMD_SET_INTEGRAL_TIME: number

Sets the integral time.

IN: [1:cmd][2:integral_time] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ✓

Const CMD_SET_LEDS

CMD_SET_LEDS: number

Set the LED state. Using a repeat value of anything other than 0 will block the processor for the duration of the command.

If repeat is not 0, then the LEDs are reset to all off at the end of the sequence.

IN: [1:cmd][1:led_state][1:repeat][1:on-time][1:off-time] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ✓

Const CMD_SET_MEASURE_MODE

CMD_SET_MEASURE_MODE: number

Sets the measurement mode. The mode can either be frequency or pulse duration. The former is well tested, but the latter is much more precise.

IN: [1:cmd][1:measure_mode] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_SET_MULTIPLIER

CMD_SET_MULTIPLIER: number

Sets the multiplier value.

IN: [1:cmd][1:multiplier_value] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ✓

Const CMD_SET_OWNER_EMAIL

CMD_SET_OWNER_EMAIL: number

Set User's Email Address

IN: [1:cmd][60:owner-email] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_OWNER_NAME

CMD_SET_OWNER_NAME: number

Set User's Name

IN: [1:cmd][60:owner-name] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_PCB_ERRATA

CMD_SET_PCB_ERRATA: number

Sets the board errata value. Board errata is used to correct swapped LEDs and any future problems discovered that only affect some batches of hardware version 1.

The errata bitmask is as follows: 0x00 = No errata for this PCB 0x01 = Leds are swapped 0x02-0xffff = Reserved for future use

IN: [1:cmd][2:pcb_errata] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_POST_SCALE

CMD_SET_POST_SCALE: number

Set the post XYZ scaling constant. scale is a packed float.

IN: [1:cmd][4:scale] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_SET_PRE_SCALE

CMD_SET_PRE_SCALE: number

Set the pre XYZ scaling constant. scale is a packed float.

IN: [1:cmd][4:scale] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_SET_REMOTE_HASH

CMD_SET_REMOTE_HASH: number

Sets the remote SHA1 hash of the profile. This is designed to be used by the calibration program to indicate the key which allows the completed profile to be found from a public web service.

IN: [1:cmd][20:sha1_hash] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_SET_SERIAL_NUMBER

CMD_SET_SERIAL_NUMBER: number

Sets the device serial number.

IN: [1:cmd][4:serial_number] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_TAKE_READINGS

CMD_TAKE_READINGS: number

Take a reading taking into account just dark offsets. All of red, green and blue are packed float values.

This command is useful if you want to do an ambient reading.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:red][4:green][4:blue]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_TAKE_READING_ARRAY

CMD_TAKE_READING_ARRAY: number

Takes 30 raw samples and returns them in an array.

This command can be used to find the optimum delay between patches by showing a black sample area, then white, and then using this command to find out how long the actual hardware delay is.

It can also be used to find out how stable the device or output is over a small amount of time, typically ~2.5 seconds for the maximum integral time.

IN: [1:cmd] OUT: [1:retval][1:cmd][30:reading_array]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | × ColorHugALS | × | ×

Const CMD_TAKE_READING_RAW

CMD_TAKE_READING_RAW: number

Take a raw reading.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:count]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ✓

Const CMD_TAKE_READING_SPECTRAL

CMD_TAKE_READING_SPECTRAL: number

Takes a spectral reading putting %CH_CCD_SPECTRAL_RESOLUTION uint16_t values (typically 7296 bytes) in SRAM. The values are scaled from 0x0000 to 0x03ff and correspond to the actual signal amplitude once Vref- and Vref+ have been taken into account.

IN: [1:cmd] OUT: [1:retval][1:cmd][4:addr]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | × ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_TAKE_READING_XYZ

CMD_TAKE_READING_XYZ: number

Take a reading taking into account:

dark offsets
the calibration matrix

If the calibration index > %CH_CALIBRATION_MAX then the calibration map is used to find the default calibration index to use.

If the calibration index is set to %CH_CALIBRATION_SPECTRAL then the spectral hardware is used if it is available. The CIE 1931 luminosity function data is used by default.

IN: [1:cmd][2:calibration-index] OUT: [1:retval][1:cmd][4:red][4:green][4:blue]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_WRITE_EEPROM

CMD_WRITE_EEPROM: number

Write values to EEPROM.

IN: [1:cmd][8:eeprom_magic] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | ✓ ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const CMD_WRITE_FLASH

CMD_WRITE_FLASH: number

Write raw data to the flash memory. You can only write aligned to a 32 byte boundary, and you must flush any incomplete 64 byte block.

IN: [1:cmd][2:address][1:length][1:checksum][1-32:data] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | ✓ | × ColorHug2 | ✓ | × ColorHug+ | ✓ | × ColorHugALS | ✓ | ×

Const CMD_WRITE_SRAM

CMD_WRITE_SRAM: number

Write raw data to the SRAM memory.

IN: [1:cmd][2:address][1:length][1-60:data] OUT: [1:retval][1:cmd]

This command is available under these conditions:

           |  Bootloader  |  Firmware

---------------+--------------+----------- ColorHug | × | × ColorHug2 | × | ✓ ColorHug+ | × | ✓ ColorHugALS | × | ×

Const DEVICE_GUID_COLORHUG

DEVICE_GUID_COLORHUG: string

Const DEVICE_GUID_COLORHUG2

DEVICE_GUID_COLORHUG2: string

Const DEVICE_GUID_COLORHUG_ALS

DEVICE_GUID_COLORHUG_ALS: string

Const DEVICE_GUID_COLORHUG_PLUS

DEVICE_GUID_COLORHUG_PLUS: string

Const DEVICE_USB_TIMEOUT

DEVICE_USB_TIMEOUT: number

Const EEPROM_ADDR_RUNCODE

EEPROM_ADDR_RUNCODE: number

Const EEPROM_ADDR_RUNCODE_ALS

EEPROM_ADDR_RUNCODE_ALS: number

Const EP0_TRANSFER_SIZE

EP0_TRANSFER_SIZE: number

Const EP0_TRANSFER_SIZE_V2

EP0_TRANSFER_SIZE_V2: number

Const FIRMWARE_ID_TOKEN1

FIRMWARE_ID_TOKEN1: string

Const FIRMWARE_ID_TOKEN2

FIRMWARE_ID_TOKEN2: string

Const FIRMWARE_ID_TOKEN_ALS

FIRMWARE_ID_TOKEN_ALS: string

Const FIRMWARE_ID_TOKEN_PLUS

FIRMWARE_ID_TOKEN_PLUS: string

Const FLASH_ERASE_BLOCK_SIZE

FLASH_ERASE_BLOCK_SIZE: number

Const FLASH_RECONNECT_TIMEOUT

FLASH_RECONNECT_TIMEOUT: number

Const FLASH_TRANSFER_BLOCK_SIZE

FLASH_TRANSFER_BLOCK_SIZE: number

Const FLASH_WRITE_BLOCK_SIZE

FLASH_WRITE_BLOCK_SIZE: number

Const INTEGRAL_TIME_VALUE_100MS

INTEGRAL_TIME_VALUE_100MS: number

Const INTEGRAL_TIME_VALUE_200MS

INTEGRAL_TIME_VALUE_200MS: number

Const INTEGRAL_TIME_VALUE_50MS

INTEGRAL_TIME_VALUE_50MS: number

Const INTEGRAL_TIME_VALUE_5MS

INTEGRAL_TIME_VALUE_5MS: number

Const INTEGRAL_TIME_VALUE_MAX

INTEGRAL_TIME_VALUE_MAX: number

Const OWNER_LENGTH_MAX

OWNER_LENGTH_MAX: number

Const USB_CONFIG

USB_CONFIG: number

Const USB_HID_EP

USB_HID_EP: number

Const USB_HID_EP_IN

USB_HID_EP_IN: number

Const USB_HID_EP_OUT

USB_HID_EP_OUT: number

Const USB_HID_EP_SIZE

USB_HID_EP_SIZE: number

Const USB_INTERFACE

USB_INTERFACE: number

Const USB_PID_BOOTLOADER

USB_PID_BOOTLOADER: number

Const USB_PID_BOOTLOADER2

USB_PID_BOOTLOADER2: number

Const USB_PID_BOOTLOADER_ALS

USB_PID_BOOTLOADER_ALS: number

Const USB_PID_BOOTLOADER_PLUS

USB_PID_BOOTLOADER_PLUS: number

Const USB_PID_FIRMWARE

USB_PID_FIRMWARE: number

Const USB_PID_FIRMWARE2

USB_PID_FIRMWARE2: number

Const USB_PID_FIRMWARE_ALS

USB_PID_FIRMWARE_ALS: number

Const USB_PID_FIRMWARE_ALS_SENSOR_HID

USB_PID_FIRMWARE_ALS_SENSOR_HID: number

Const USB_PID_FIRMWARE_PLUS

USB_PID_FIRMWARE_PLUS: number

Const USB_PID_LEGACY

USB_PID_LEGACY: number

Const USB_VID

USB_VID: number

Const USB_VID_LEGACY

USB_VID_LEGACY: number

Const WRITE_EEPROM_MAGIC

WRITE_EEPROM_MAGIC: string

Functions

colorSelectToString

colorSelectToString(colorSelect: ColorSelect): string

- Defined in ColorHug-1.0.d.ts:1300
Parameters
- colorSelect: ColorSelect
Returns string

commandToString

commandToString(cmd: number): string

- Defined in ColorHug-1.0.d.ts:1301
Parameters
- cmd: number
Returns string

deviceCheckFirmware

deviceCheckFirmware(device: GUsb.Device, data: number, dataLen: number): boolean

- Defined in ColorHug-1.0.d.ts:1308
Checks the firmware is suitable for the ColorHug device that is attached.

Parameters
- device: GUsb.Device
- data: number
  
  firmware binary data
- dataLen: number
  
  size of data
Returns boolean

deviceClose

deviceClose(device: GUsb.Device): boolean

- Defined in ColorHug-1.0.d.ts:1309
Parameters
- device: GUsb.Device
Returns boolean

deviceErrorQuark

deviceErrorQuark(): Quark

- Defined in ColorHug-1.0.d.ts:1310
Returns Quark

deviceGetAdcCalibrationNeg

deviceGetAdcCalibrationNeg(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, number]

- Defined in ColorHug-1.0.d.ts:1316
Gets the ADC positive calibration value.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, number]

deviceGetAdcCalibrationPos

deviceGetAdcCalibrationPos(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, number]

- Defined in ColorHug-1.0.d.ts:1322
Gets the ADC positive calibration value.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, number]

deviceGetCcdCalibration

deviceGetCcdCalibration(device: GUsb.Device, nmStart: number, c0: number, c1: number, c2: number, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1332
Gets any PCB wavelength_cal from the device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- nmStart: number
- c0: number
- c1: number
- c2: number
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceGetError

deviceGetError(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, ColorHug.Error, Cmd]

- Defined in ColorHug-1.0.d.ts:1338
Gets the status for the last operation.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, ColorHug.Error, Cmd]

deviceGetGuid

deviceGetGuid(device: GUsb.Device): string

- Defined in ColorHug-1.0.d.ts:1343
Returns the GUID for the connected ColorHug device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
Returns string

deviceGetIlluminants

deviceGetIlluminants(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, Illuminant]

- Defined in ColorHug-1.0.d.ts:1349
Gets the illuminants from the device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, Illuminant]

deviceGetIntegralTime

deviceGetIntegralTime(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, number]

- Defined in ColorHug-1.0.d.ts:1355
Gets the integration time used for taking the next samples.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, number]

deviceGetLeds

deviceGetLeds(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, StatusLed]

- Defined in ColorHug-1.0.d.ts:1361
Gets the LEDs from the device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, StatusLed]

deviceGetMode

deviceGetMode(device: GUsb.Device): ColorHug.DeviceMode

- Defined in ColorHug-1.0.d.ts:1362
Parameters
- device: GUsb.Device
Returns ColorHug.DeviceMode

deviceGetPcbErrata

deviceGetPcbErrata(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, PcbErrata]

- Defined in ColorHug-1.0.d.ts:1368
Gets any PCB errata from the device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, PcbErrata]

deviceGetRuncodeAddress

deviceGetRuncodeAddress(device: GUsb.Device): number

- Defined in ColorHug-1.0.d.ts:1373
Returns the runcode address for the ColorHug device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
Returns number

deviceGetSerialNumber

deviceGetSerialNumber(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, number]

- Defined in ColorHug-1.0.d.ts:1379
Gets the serial number from the device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, number]

deviceGetSpectrum

deviceGetSpectrum(device: GUsb.Device, cancellable: Gio.Cancellable): Spectrum

- Defined in ColorHug-1.0.d.ts:1386
Gets the spectrum from the device. This queries the device multiple times until the spectrum has been populated.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns Spectrum

deviceGetSpectrumFull

deviceGetSpectrumFull(device: GUsb.Device, kind: SpectrumKind, cancellable: Gio.Cancellable): Spectrum

- Defined in ColorHug-1.0.d.ts:1394
Gets the spectrum from the device. This queries the device multiple times until the spectrum has been populated.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- kind: SpectrumKind
  
  A #ChSpectrumKind
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns Spectrum

deviceGetTemperature

deviceGetTemperature(device: GUsb.Device, cancellable: Gio.Cancellable): [boolean, number]

- Defined in ColorHug-1.0.d.ts:1400
Gets the PCB board temperature from the device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns [boolean, number]

deviceIsColorhug

deviceIsColorhug(device: GUsb.Device): boolean

- Defined in ColorHug-1.0.d.ts:1401
Parameters
- device: GUsb.Device
Returns boolean

deviceLoadSram

deviceLoadSram(device: GUsb.Device, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1407
Loads the entire SRAM from the device EEPROM.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceModeFromFirmware

deviceModeFromFirmware(data: number, dataLen: number): ColorHug.DeviceMode

- Defined in ColorHug-1.0.d.ts:1415
Gets the device mode from the unique code stored in the firmware data. The firmware identifier has been present since colorhug-1.2.2.bin for ColorHug and all firmware versions for ColorHug2 and ColorHug+.

Parameters
- data: number
  
  firmware binary data
- dataLen: number
  
  size of data
Returns ColorHug.DeviceMode

deviceModeToString

deviceModeToString(deviceMode: ColorHug.DeviceMode): string

- Defined in ColorHug-1.0.d.ts:1416
Parameters
- deviceMode: ColorHug.DeviceMode
Returns string

deviceOpen

deviceOpen(device: GUsb.Device): boolean

- Defined in ColorHug-1.0.d.ts:1417
Parameters
- device: GUsb.Device
Returns boolean

deviceOpenFull

deviceOpenFull(device: GUsb.Device, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1423
Opens the device ready for use.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceReadSram

deviceReadSram(device: GUsb.Device, addr: number, len: number, cancellable: Gio.Cancellable): any

- Defined in ColorHug-1.0.d.ts:1431
Reads a value from the SRAM.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- addr: number
- len: number
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns any

deviceSaveSram

deviceSaveSram(device: GUsb.Device, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1437
Saves the entire SRAM space into the device EEPROM.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSelfTest

deviceSelfTest(device: GUsb.Device, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1443
Performs a self test on the device

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetCcdCalibration

deviceSetCcdCalibration(device: GUsb.Device, nmStart: number, c0: number, c1: number, c2: number, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1453
Sets any PCB wavelength_cal on the device

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- nmStart: number
- c0: number
- c1: number
- c2: number
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetCryptoKey

deviceSetCryptoKey(device: GUsb.Device, keys: number, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1462
Sets the firmware signing keys on the device.

IMPORTANT: This can only be called once until the device is unlocked.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- keys: number
  
  a set of XTEA keys
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetIlluminants

deviceSetIlluminants(device: GUsb.Device, value: Illuminant, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1469
Sets the illuminants on the device

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- value: Illuminant
  
  serial number
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetIntegralTime

deviceSetIntegralTime(device: GUsb.Device, value: number, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1476
Sets the integration value for the next sample.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- value: number
  
  integration time in ms
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetLeds

deviceSetLeds(device: GUsb.Device, value: StatusLed, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1483
Sets the LEDs on the device

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- value: StatusLed
  
  serial number
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetPcbErrata

deviceSetPcbErrata(device: GUsb.Device, value: PcbErrata, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1490
Sets any PCB errata on the device

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- value: PcbErrata
  
  #ChPcbErrata, e.g. %CH_PCB_ERRATA_SWAPPED_LEDS
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetSerialNumber

deviceSetSerialNumber(device: GUsb.Device, value: number, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1497
Sets the serial number on the device

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- value: number
  
  serial number
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceSetSpectrumFull

deviceSetSpectrumFull(device: GUsb.Device, kind: SpectrumKind, sp: Spectrum, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1506
Sets the spectrum from the device. This sends data multiple multiple times until the spectrum has been populated.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- kind: SpectrumKind
  
  A #ChSpectrumKind
- sp: Spectrum
  
  A #CdSpectrum
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceTakeReadingSpectral

deviceTakeReadingSpectral(device: GUsb.Device, value: SpectrumKind, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1513
Takes a reading from the device.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- value: SpectrumKind
  
  a #ChSpectrumKind, e.g. %CH_SPECTRUM_KIND_RAW
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

deviceTakeReadingXyz

deviceTakeReadingXyz(device: GUsb.Device, calibrationIdx: number, cancellable: Gio.Cancellable): ColorXYZ

- Defined in ColorHug-1.0.d.ts:1520
Takes a reading from the device and returns the XYZ value.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- calibrationIdx: number
  
  A calibration index or 0 for none
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns ColorXYZ

deviceWriteCommand

deviceWriteCommand(device: GUsb.Device, cmd: number, bufferIn: number, bufferInLen: number, bufferOut: number, bufferOutLen: number, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1531
Sends a message to the device and waits for a reply.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cmd: number
  
  The command to use, e.g. %CH_CMD_GET_COLOR_SELECT
- bufferIn: number
  
  The input buffer of data, or %NULL
- bufferInLen: number
  
  The input buffer length
- bufferOut: number
  
  The output buffer of data, or %NULL
- bufferOutLen: number
  
  The output buffer length
- cancellable: Gio.Cancellable
  
  A #GCancellable or %NULL
Returns boolean

deviceWriteCommandAsync

deviceWriteCommandAsync(device: GUsb.Device, cmd: number, bufferIn: number, bufferInLen: number, bufferOut: number, bufferOutLen: number, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in ColorHug-1.0.d.ts:1543
Sends a message to the device and waits for a reply.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- cmd: number
  
  The command to use, e.g. %CH_CMD_GET_COLOR_SELECT
- bufferIn: number
  
  The input buffer of data, or %NULL
- bufferInLen: number
  
  The input buffer length
- bufferOut: number
  
  The output buffer of data, or %NULL
- bufferOutLen: number
  
  The output buffer length
- cancellable: Gio.Cancellable
  
  A #GCancellable, or %NULL
- callback: AsyncReadyCallback
  
  A #GAsyncReadyCallback that will be called when finished.
Returns void

deviceWriteCommandFinish

deviceWriteCommandFinish(device: GUsb.Device, res: AsyncResult): boolean

- Defined in ColorHug-1.0.d.ts:1549
Gets the result from the asynchronous function.

Parameters
- device: GUsb.Device
  
  a #GUsbDevice instance.
- res: AsyncResult
  
  the #GAsyncResult
Returns boolean

deviceWriteSram

deviceWriteSram(device: GUsb.Device, addr: number, data: any, cancellable: Gio.Cancellable): boolean

- Defined in ColorHug-1.0.d.ts:1557
Loads the entire SRAM from the device EEPROM.

Parameters
- device: GUsb.Device
  
  A #GUsbDevice
- addr: number
- data: any
  
  A #GBytes
- cancellable: Gio.Cancellable
  
  a #GCancellable, or %NULL
Returns boolean

measureModeToString

measureModeToString(measureMode: MeasureMode): string

- Defined in ColorHug-1.0.d.ts:1558
Parameters
- measureMode: MeasureMode
Returns string

multiplierToString

multiplierToString(multiplier: FreqScale): string

- Defined in ColorHug-1.0.d.ts:1559
Parameters
- multiplier: FreqScale
Returns string

sha1Parse

sha1Parse(value: string, sha1: Sha1): boolean

- Defined in ColorHug-1.0.d.ts:1565
Parses a SHA1 hash from a string value.

Parameters
- value: string
  
  A string representation of the SHA1 hash
- sha1: Sha1
  
  A %ChSha1
Returns boolean

strerror

strerror(errorEnum: ColorHug.Error): string

- Defined in ColorHug-1.0.d.ts:1566
Parameters
- errorEnum: ColorHug.Error
Returns string