MT2523 API Reference  LinkIt SDK v4
Enum

Overview

Enumerations

enum  hal_isink_channel_t {
  HAL_ISINK_CHANNEL_0 = 0,
  HAL_ISINK_CHANNEL_1 = 1,
  HAL_ISINK_MAX_CHANNEL
}
 ISINK channel. More...
 
enum  hal_isink_clock_source_t {
  HAL_ISINK_CLOCK_SOURCE_32KHZ = 0,
  HAL_ISINK_CLOCK_SOURCE_2MHZ = 1
}
 ISINK clock source seletion. More...
 
enum  hal_isink_mode_t {
  HAL_ISINK_MODE_PWM = 0,
  HAL_ISINK_MODE_BREATH = 1,
  HAL_ISINK_MODE_REGISTER = 2
}
 ISINK operating mode seletion. More...
 
enum  hal_isink_current_t {
  HAL_ISINK_OUTPUT_CURRENT_4_MA = 0,
  HAL_ISINK_OUTPUT_CURRENT_8_MA = 1,
  HAL_ISINK_OUTPUT_CURRENT_12_MA = 2,
  HAL_ISINK_OUTPUT_CURRENT_16_MA = 3,
  HAL_ISINK_OUTPUT_CURRENT_20_MA = 4,
  HAL_ISINK_OUTPUT_CURRENT_24_MA = 5
}
 ISINK output current seletion. More...
 
enum  hal_isink_breath_adjust_on_t {
  HAL_ISINK_TIME_0_123_SECOND = 0,
  HAL_ISINK_TIME_0_338_SECOND = 1,
  HAL_ISINK_TIME_0_523_SECOND = 2,
  HAL_ISINK_TIME_0_707_SECOND = 3,
  HAL_ISINK_TIME_0_926_SECOND = 4,
  HAL_ISINK_TIME_1_107_SECOND = 5,
  HAL_ISINK_TIME_1_291_SECOND = 6,
  HAL_ISINK_TIME_1_507_SECOND = 7,
  HAL_ISINK_TIME_1_691_SECOND = 8,
  HAL_ISINK_TIME_1_876_SECOND = 9,
  HAL_ISINK_TIME_2_091_SECOND = 10,
  HAL_ISINK_TIME_2_276_SECOND = 11,
  HAL_ISINK_TIME_2_460_SECOND = 12,
  HAL_ISINK_TIME_2_676_SECOND = 13,
  HAL_ISINK_TIME_2_860_SECOND = 14,
  HAL_ISINK_TIME_3_075_SECOND = 15
}
 ISINK breath mode based ont the time adjustment and brightness levels. More...
 
enum  hal_isink_breath_adjust_off_t {
  HAL_ISINK_TIME_0_246_SECOND = 0,
  HAL_ISINK_TIME_0_677_SECOND = 1,
  HAL_ISINK_TIME_1_046_SECOND = 2,
  HAL_ISINK_TIME_1_417_SECOND = 3,
  HAL_ISINK_TIME_1_845_SECOND = 4,
  HAL_ISINK_TIME_2_214_SECOND = 5,
  HAL_ISINK_TIME_2_583_SECOND = 6,
  HAL_ISINK_TIME_3_014_SECOND = 7,
  HAL_ISINK_TIME_3_383_SECOND = 8,
  HAL_ISINK_TIME_3_752_SECOND = 9,
  HAL_ISINK_TIME_4_183_SECOND = 10,
  HAL_ISINK_TIME_4_552_SECOND = 11,
  HAL_ISINK_TIME_4_921_SECOND = 12,
  HAL_ISINK_TIME_5_351_SECOND = 13,
  HAL_ISINK_TIME_5_720_SECOND = 14,
  HAL_ISINK_TIME_6_151_SECOND = 15
}
 ISINK breath mode off based on each time adjustment. More...
 
enum  hal_isink_status_t {
  HAL_ISINK_STATUS_ERROR = -3,
  HAL_ISINK_STATUS_ERROR_CHANNEL = -2,
  HAL_ISINK_STATUS_ERROR_INVALID_PARAMETER = -1,
  HAL_ISINK_STATUS_OK = 0
}
 ISINK status. More...
 
enum  hal_isink_running_status_t {
  HAL_ISINK_IDLE = 0,
  HAL_ISINK_BUSY = 1
}
 This enum defines the ISINK running status. More...
 

Enumeration Type Documentation

ISINK breath mode off based on each time adjustment.

Enumerator
HAL_ISINK_TIME_0_246_SECOND 

The ISINK breath adjustment time, 0.246s.

HAL_ISINK_TIME_0_677_SECOND 

The ISINK breath adjustment time, 0.677s.

HAL_ISINK_TIME_1_046_SECOND 

The ISINK breath adjustment time, 1.046s.

HAL_ISINK_TIME_1_417_SECOND 

The ISINK breath adjustment time, 1.417s.

HAL_ISINK_TIME_1_845_SECOND 

The ISINK breath adjustment time, 1.845s.

HAL_ISINK_TIME_2_214_SECOND 

The ISINK breath adjustment time, 2.214s.

HAL_ISINK_TIME_2_583_SECOND 

The ISINK breath adjustment time, 2.583s.

HAL_ISINK_TIME_3_014_SECOND 

The ISINK breath adjustment time, 3.014s.

HAL_ISINK_TIME_3_383_SECOND 

The ISINK breath adjustment time, 3.383s.

HAL_ISINK_TIME_3_752_SECOND 

The ISINK breath adjustment time, 3.752s.

HAL_ISINK_TIME_4_183_SECOND 

The ISINK breath adjustment time, 4.183s.

HAL_ISINK_TIME_4_552_SECOND 

The ISINK breath adjustment time, 4.552s.

HAL_ISINK_TIME_4_921_SECOND 

The ISINK breath adjustment time, 4.921s.

HAL_ISINK_TIME_5_351_SECOND 

The ISINK breath adjustment time, 5.351s.

HAL_ISINK_TIME_5_720_SECOND 

The ISINK breath adjustment time, 5.720s.

HAL_ISINK_TIME_6_151_SECOND 

The ISINK breath adjustment time, 6.151s.

ISINK breath mode based ont the time adjustment and brightness levels.

Enumerator
HAL_ISINK_TIME_0_123_SECOND 

The ISINK breath adjustment time, 0.123s.

HAL_ISINK_TIME_0_338_SECOND 

The ISINK breath adjustment time, 0.338s.

HAL_ISINK_TIME_0_523_SECOND 

The ISINK breath adjustment time, 0.523s.

HAL_ISINK_TIME_0_707_SECOND 

The ISINK breath adjustment time, 0.707s.

HAL_ISINK_TIME_0_926_SECOND 

The ISINK breath adjustment time, 0.926s.

HAL_ISINK_TIME_1_107_SECOND 

The ISINK breath adjustment time, 1.107s.

HAL_ISINK_TIME_1_291_SECOND 

The ISINK breath adjustment time, 1.291s.

HAL_ISINK_TIME_1_507_SECOND 

The ISINK breath adjustment time, 1.507s.

HAL_ISINK_TIME_1_691_SECOND 

The ISINK breath adjustment time, 1.691s.

HAL_ISINK_TIME_1_876_SECOND 

The ISINK breath adjustment time, 1.876s.

HAL_ISINK_TIME_2_091_SECOND 

The ISINK breath adjustment time, 2.091s.

HAL_ISINK_TIME_2_276_SECOND 

The ISINK breath adjustment time, 2.276s.

HAL_ISINK_TIME_2_460_SECOND 

The ISINK breath adjustment time, 2.460s.

HAL_ISINK_TIME_2_676_SECOND 

The ISINK breath adjustment time, 2.676s.

HAL_ISINK_TIME_2_860_SECOND 

The ISINK breath adjustment time, 2.860s.

HAL_ISINK_TIME_3_075_SECOND 

The ISINK breath adjustment time, 3.075s.

ISINK channel.

Enumerator
HAL_ISINK_CHANNEL_0 

The ISINK channel 0.

HAL_ISINK_CHANNEL_1 

The ISINK channel 1.

HAL_ISINK_MAX_CHANNEL 

The ISINK maximum channel (invalid).

ISINK clock source seletion.

Enumerator
HAL_ISINK_CLOCK_SOURCE_32KHZ 

The ISINK clock source 32kHz.

HAL_ISINK_CLOCK_SOURCE_2MHZ 

The ISINK clock source 2MHz.

ISINK output current seletion.

Enumerator
HAL_ISINK_OUTPUT_CURRENT_4_MA 

The ISINK output current 4 mA.

HAL_ISINK_OUTPUT_CURRENT_8_MA 

The ISINK output current 8 mA.

HAL_ISINK_OUTPUT_CURRENT_12_MA 

The ISINK output current 12 mA.

HAL_ISINK_OUTPUT_CURRENT_16_MA 

The ISINK output current 16 mA.

HAL_ISINK_OUTPUT_CURRENT_20_MA 

The ISINK output current 20mA.

HAL_ISINK_OUTPUT_CURRENT_24_MA 

The ISINK output current 24mA.

ISINK operating mode seletion.

Enumerator
HAL_ISINK_MODE_PWM 

The PWM mode.

HAL_ISINK_MODE_BREATH 

The Breath mode.

HAL_ISINK_MODE_REGISTER 

The Register mode.

This enum defines the ISINK running status.

Enumerator
HAL_ISINK_IDLE 

The ISINK is idle.

HAL_ISINK_BUSY 

The ISINK is busy.

ISINK status.

Enumerator
HAL_ISINK_STATUS_ERROR 

The ISINK function error occurred.

HAL_ISINK_STATUS_ERROR_CHANNEL 

The ISINK error channel.

HAL_ISINK_STATUS_ERROR_INVALID_PARAMETER 

An error occurred, invalid parameter was given.

HAL_ISINK_STATUS_OK 

The ISINK operation completed successfully.