ssd1681 base driver modules More...

Collaboration diagram for ssd1681 base driver function:

Data Structures
struct	ssd1681_handle_s
	ssd1681 handle structure definition More...
struct	ssd1681_info_s
	ssd1681 information structure definition More...

Macros
#define	SSD1681_BUSY_MAX_DELAY_MS 10
	ssd1681 busy max delay definition
#define	SSD1681_BUSY_MAX_RETRY_TIMES 2000
	ssd1681 busy max retry times definition

Typedefs
typedef struct ssd1681_handle_s	ssd1681_handle_t
	ssd1681 handle structure definition
typedef struct ssd1681_info_s	ssd1681_info_t
	ssd1681 information structure definition

Enumerations
enum	ssd1681_bool_t { SSD1681_BOOL_FALSE = 0x00 , SSD1681_BOOL_TRUE = 0x01 }
	ssd1681 bool enumeration definition More...
enum	ssd1681_gate_driving_voltage_t { SSD1681_GATE_DRIVING_VOLTAGE_10V = 0x03 , SSD1681_GATE_DRIVING_VOLTAGE_10P5V = 0x04 , SSD1681_GATE_DRIVING_VOLTAGE_11V = 0x05 , SSD1681_GATE_DRIVING_VOLTAGE_11P5V = 0x06 , SSD1681_GATE_DRIVING_VOLTAGE_12V = 0x07 , SSD1681_GATE_DRIVING_VOLTAGE_12P5V = 0x08 , SSD1681_GATE_DRIVING_VOLTAGE_13V = 0x09 , SSD1681_GATE_DRIVING_VOLTAGE_13P5V = 0x0A , SSD1681_GATE_DRIVING_VOLTAGE_14V = 0x0B , SSD1681_GATE_DRIVING_VOLTAGE_14P5V = 0x0C , SSD1681_GATE_DRIVING_VOLTAGE_15V = 0x0D , SSD1681_GATE_DRIVING_VOLTAGE_15P5V = 0x0E , SSD1681_GATE_DRIVING_VOLTAGE_16V = 0x0F , SSD1681_GATE_DRIVING_VOLTAGE_16P5V = 0x10 , SSD1681_GATE_DRIVING_VOLTAGE_17V = 0x11 , SSD1681_GATE_DRIVING_VOLTAGE_17P5V = 0x12 , SSD1681_GATE_DRIVING_VOLTAGE_18V = 0x13 , SSD1681_GATE_DRIVING_VOLTAGE_18P5V = 0x14 , SSD1681_GATE_DRIVING_VOLTAGE_19V = 0x15 , SSD1681_GATE_DRIVING_VOLTAGE_19P5V = 0x16 , SSD1681_GATE_DRIVING_VOLTAGE_20V = 0x17 }
	ssd1681 gate driving voltage enumeration definition More...
enum	ssd1681_vsh_t { SSD1681_VSH_2P4V = 0x8E , SSD1681_VSH_2P5V = 0x8F , SSD1681_VSH_2P6V = 0x90 , SSD1681_VSH_2P7V = 0x91 , SSD1681_VSH_2P8V = 0x92 , SSD1681_VSH_2P9V = 0x93 , SSD1681_VSH_3V = 0x94 , SSD1681_VSH_3P1V = 0x95 , SSD1681_VSH_3P2V = 0x96 , SSD1681_VSH_3P3V = 0x97 , SSD1681_VSH_3P4V = 0x98 , SSD1681_VSH_3P5V = 0x99 , SSD1681_VSH_3P6V = 0x9A , SSD1681_VSH_3P7V = 0x9B , SSD1681_VSH_3P8V = 0x9C , SSD1681_VSH_3P9V = 0x9D , SSD1681_VSH_4V = 0x9E , SSD1681_VSH_4P1V = 0x9F , SSD1681_VSH_4P2V = 0xA0 , SSD1681_VSH_4P3V = 0xA1 , SSD1681_VSH_4P4V = 0xA2 , SSD1681_VSH_4P5V = 0xA3 , SSD1681_VSH_4P6V = 0xA4 , SSD1681_VSH_4P7V = 0xA5 , SSD1681_VSH_4P8V = 0xA6 , SSD1681_VSH_4P9V = 0xA7 , SSD1681_VSH_5V = 0xA8 , SSD1681_VSH_5P1V = 0xA9 , SSD1681_VSH_5P2V = 0xAA , SSD1681_VSH_5P3V = 0xAB , SSD1681_VSH_5P4V = 0xAC , SSD1681_VSH_5P5V = 0xAD , SSD1681_VSH_5P6V = 0xAE , SSD1681_VSH_5P7V = 0xAF , SSD1681_VSH_5P8V = 0xB0 , SSD1681_VSH_5P9V = 0xB1 , SSD1681_VSH_6V = 0xB2 , SSD1681_VSH_6P1V = 0xB3 , SSD1681_VSH_6P2V = 0xB4 , SSD1681_VSH_6P3V = 0xB5 , SSD1681_VSH_6P4V = 0xB6 , SSD1681_VSH_6P5V = 0xB7 , SSD1681_VSH_6P6V = 0xB8 , SSD1681_VSH_6P7V = 0xB9 , SSD1681_VSH_6P8V = 0xBA , SSD1681_VSH_6P9V = 0xBB , SSD1681_VSH_7V = 0xBC , SSD1681_VSH_7P1V = 0xBD , SSD1681_VSH_7P2V = 0xBE , SSD1681_VSH_7P3V = 0xBF , SSD1681_VSH_7P4V = 0xC0 , SSD1681_VSH_7P5V = 0xC1 , SSD1681_VSH_7P6V = 0xC2 , SSD1681_VSH_7P7V = 0xC3 , SSD1681_VSH_7P8V = 0xC4 , SSD1681_VSH_7P9V = 0xC5 , SSD1681_VSH_8V = 0xC6 , SSD1681_VSH_8P1V = 0xC7 , SSD1681_VSH_8P2V = 0xC8 , SSD1681_VSH_8P3V = 0xC9 , SSD1681_VSH_8P4V = 0xCA , SSD1681_VSH_8P5V = 0xCB , SSD1681_VSH_8P6V = 0xCC , SSD1681_VSH_8P7V = 0xCD , SSD1681_VSH_8P8V = 0xCE , SSD1681_VSH_9V = 0x23 , SSD1681_VSH_9P2V = 0x24 , SSD1681_VSH_9P4V = 0x25 , SSD1681_VSH_9P6V = 0x26 , SSD1681_VSH_9P8V = 0x27 , SSD1681_VSH_10V = 0x28 , SSD1681_VSH_10P2V = 0x29 , SSD1681_VSH_10P4V = 0x2A , SSD1681_VSH_10P6V = 0x2B , SSD1681_VSH_10P8V = 0x2C , SSD1681_VSH_11V = 0x2D , SSD1681_VSH_11P2V = 0x2E , SSD1681_VSH_11P4V = 0x2F , SSD1681_VSH_11P6V = 0x30 , SSD1681_VSH_11P8V = 0x31 , SSD1681_VSH_12V = 0x32 , SSD1681_VSH_12P2V = 0x33 , SSD1681_VSH_12P4V = 0x34 , SSD1681_VSH_12P6V = 0x35 , SSD1681_VSH_12P8V = 0x36 , SSD1681_VSH_13V = 0x37 , SSD1681_VSH_13P2V = 0x38 , SSD1681_VSH_13P4V = 0x39 , SSD1681_VSH_13P6V = 0x3A , SSD1681_VSH_13P8V = 0x3B , SSD1681_VSH_14V = 0x3C , SSD1681_VSH_14P2V = 0x3D , SSD1681_VSH_14P4V = 0x3E , SSD1681_VSH_14P6V = 0x3F , SSD1681_VSH_14P8V = 0x40 , SSD1681_VSH_15V = 0x41 , SSD1681_VSH_15P2V = 0x42 , SSD1681_VSH_15P4V = 0x43 , SSD1681_VSH_15P6V = 0x44 , SSD1681_VSH_15P8V = 0x45 , SSD1681_VSH_16V = 0x46 , SSD1681_VSH_16P2V = 0x47 , SSD1681_VSH_16P4V = 0x48 , SSD1681_VSH_16P6V = 0x49 , SSD1681_VSH_16P8V = 0x4A , SSD1681_VSH_17V = 0x4B }
	ssd1681 vsh enumeration definition More...
enum	ssd1681_vsl_t { SSD1681_VSL_NEGATIVE_5 = 0x0A , SSD1681_VSL_NEGATIVE_5P5 = 0x0C , SSD1681_VSL_NEGATIVE_6 = 0x0E , SSD1681_VSL_NEGATIVE_6P5 = 0x10 , SSD1681_VSL_NEGATIVE_7 = 0x12 , SSD1681_VSL_NEGATIVE_7P5 = 0x14 , SSD1681_VSL_NEGATIVE_8 = 0x16 , SSD1681_VSL_NEGATIVE_8P5 = 0x18 , SSD1681_VSL_NEGATIVE_9 = 0x1A , SSD1681_VSL_NEGATIVE_9P5 = 0x1C , SSD1681_VSL_NEGATIVE_10 = 0x1E , SSD1681_VSL_NEGATIVE_10P5 = 0x20 , SSD1681_VSL_NEGATIVE_11 = 0x22 , SSD1681_VSL_NEGATIVE_11P5 = 0x24 , SSD1681_VSL_NEGATIVE_12 = 0x26 , SSD1681_VSL_NEGATIVE_12P5 = 0x28 , SSD1681_VSL_NEGATIVE_13 = 0x2A , SSD1681_VSL_NEGATIVE_13P5 = 0x2C , SSD1681_VSL_NEGATIVE_14 = 0x2E , SSD1681_VSL_NEGATIVE_14P5 = 0x30 , SSD1681_VSL_NEGATIVE_15 = 0x32 , SSD1681_VSL_NEGATIVE_15P5 = 0x34 , SSD1681_VSL_NEGATIVE_16 = 0x36 , SSD1681_VSL_NEGATIVE_16P5 = 0x38 , SSD1681_VSL_NEGATIVE_17 = 0x3A }
	ssd1681 vsl enumeration definition More...
enum	ssd1681_driving_strength_t { SSD1681_DRIVING_STRENGTH_1 = (0 << 4) , SSD1681_DRIVING_STRENGTH_2 = (1 << 4) , SSD1681_DRIVING_STRENGTH_3 = (2 << 4) , SSD1681_DRIVING_STRENGTH_4 = (3 << 4) , SSD1681_DRIVING_STRENGTH_5 = (4 << 4) , SSD1681_DRIVING_STRENGTH_6 = (5 << 4) , SSD1681_DRIVING_STRENGTH_7 = (6 << 4) , SSD1681_DRIVING_STRENGTH_8 = (7 << 4) }
	ssd1681 driving strength enumeration definition More...
enum	ssd1681_min_off_time_t { SSD1681_MIN_OFF_TIME_2P6 = (4 << 0) , SSD1681_MIN_OFF_TIME_3P2 = (5 << 0) , SSD1681_MIN_OFF_TIME_3P9 = (6 << 0) , SSD1681_MIN_OFF_TIME_4P6 = (7 << 0) , SSD1681_MIN_OFF_TIME_5P4 = (8 << 0) , SSD1681_MIN_OFF_TIME_6P3 = (9 << 0) , SSD1681_MIN_OFF_TIME_7P3 = (10 << 0) , SSD1681_MIN_OFF_TIME_8P4 = (11 << 0) , SSD1681_MIN_OFF_TIME_9P8 = (12 << 0) , SSD1681_MIN_OFF_TIME_11P5 = (13 << 0) , SSD1681_MIN_OFF_TIME_13P8 = (14 << 0) , SSD1681_MIN_OFF_TIME_16P5 = (15 << 0) }
	ssd1681 min off time enumeration definition More...
enum	ssd1681_phase_duration_t { SSD1681_PHASE_DURATION_10MS = 0x00 , SSD1681_PHASE_DURATION_20MS = 0x01 , SSD1681_PHASE_DURATION_30MS = 0x02 , SSD1681_PHASE_DURATION_40MS = 0x03 }
	ssd1681 phase duration enumeration definition More...
enum	ssd1681_mode_t { SSD1681_MODE_NORMAL = 0x00 , SSD1681_MODE_DEEP_SLEEP_1 = 0x01 , SSD1681_MODE_DEEP_SLEEP_2 = 0x03 }
	ssd1681 mode enumeration definition More...
enum	ssd1681_address_mode_t { SSD1681_ADDRESS_MODE_Y_DECREMENT_X_DECREMENT = 0x00 , SSD1681_ADDRESS_MODE_Y_DECREMENT_X_INCREMENT = 0x01 , SSD1681_ADDRESS_MODE_Y_INCREMENT_X_DECREMENT = 0x02 , SSD1681_ADDRESS_MODE_Y_INCREMENT_X_INCREMENT = 0x03 }
	ssd1681 address mode enumeration definition More...
enum	ssd1681_address_direction_t { SSD1681_ADDRESS_DIRECTION_UPDATED_X = 0x00 , SSD1681_ADDRESS_DIRECTION_UPDATED_Y = 0x01 }
	ssd1681 address direction enumeration definition More...
enum	ssd1681_vci_level_t { SSD1681_VCI_LEVEL_2P2V = 0x3 , SSD1681_VCI_LEVEL_2P3V = 0x4 , SSD1681_VCI_LEVEL_2P4V = 0x5 , SSD1681_VCI_LEVEL_2P5V = 0x6 , SSD1681_VCI_LEVEL_2P6V = 0x7 }
	ssd1681 vci level enumeration definition More...
enum	ssd1681_temperature_sensor_t { SSD1681_TEMPERATURE_SENSOR_EXTERNAL = 0x48 , SSD1681_TEMPERATURE_SENSOR_INTERNAL = 0x80 }
	ssd1681 temperature sensor enumeration definition More...
enum	ssd1681_display_control_t { SSD1681_DISPLAY_CONTROL_NORMAL = 0x00 , SSD1681_DISPLAY_CONTROL_BYPASS = 0x04 , SSD1681_DISPLAY_CONTROL_INVERSE = 0x08 }
	ssd1681 display control enumeration definition More...
enum	ssd1681_display_sequence_t { SSD1681_DISPLAY_SEQUENCE_0 = 0x80 , SSD1681_DISPLAY_SEQUENCE_1 = 0x01 , SSD1681_DISPLAY_SEQUENCE_2 = 0xC0 , SSD1681_DISPLAY_SEQUENCE_3 = 0x03 , SSD1681_DISPLAY_SEQUENCE_4 = 0x91 , SSD1681_DISPLAY_SEQUENCE_5 = 0x99 , SSD1681_DISPLAY_SEQUENCE_6 = 0xB1 , SSD1681_DISPLAY_SEQUENCE_7 = 0xB9 , SSD1681_DISPLAY_SEQUENCE_8 = 0xC7 , SSD1681_DISPLAY_SEQUENCE_9 = 0xCF , SSD1681_DISPLAY_SEQUENCE_10 = 0xF7 , SSD1681_DISPLAY_SEQUENCE_11 = 0xFF }
	ssd1681 display sequence enumeration definition More...
enum	ssd1681_vcom_t { SSD1681_VCOM_NEGATIVE_0P2 = 0x08 , SSD1681_VCOM_NEGATIVE_0P3 = 0x0C , SSD1681_VCOM_NEGATIVE_0P4 = 0x10 , SSD1681_VCOM_NEGATIVE_0P5 = 0x14 , SSD1681_VCOM_NEGATIVE_0P6 = 0x18 , SSD1681_VCOM_NEGATIVE_0P7 = 0x1C , SSD1681_VCOM_NEGATIVE_0P8 = 0x20 , SSD1681_VCOM_NEGATIVE_0P9 = 0x24 , SSD1681_VCOM_NEGATIVE_1P0 = 0x28 , SSD1681_VCOM_NEGATIVE_1P1 = 0x2C , SSD1681_VCOM_NEGATIVE_1P2 = 0x30 , SSD1681_VCOM_NEGATIVE_1P3 = 0x34 , SSD1681_VCOM_NEGATIVE_1P4 = 0x38 , SSD1681_VCOM_NEGATIVE_1P5 = 0x3C , SSD1681_VCOM_NEGATIVE_1P6 = 0x40 , SSD1681_VCOM_NEGATIVE_1P7 = 0x44 , SSD1681_VCOM_NEGATIVE_1P8 = 0x48 , SSD1681_VCOM_NEGATIVE_1P9 = 0x4C , SSD1681_VCOM_NEGATIVE_2P0 = 0x50 , SSD1681_VCOM_NEGATIVE_2P1 = 0x54 , SSD1681_VCOM_NEGATIVE_2P2 = 0x58 , SSD1681_VCOM_NEGATIVE_2P3 = 0x5C , SSD1681_VCOM_NEGATIVE_2P4 = 0x60 , SSD1681_VCOM_NEGATIVE_2P5 = 0x64 , SSD1681_VCOM_NEGATIVE_2P6 = 0x68 , SSD1681_VCOM_NEGATIVE_2P7 = 0x6C , SSD1681_VCOM_NEGATIVE_2P8 = 0x70 , SSD1681_VCOM_NEGATIVE_2P9 = 0x74 , SSD1681_VCOM_NEGATIVE_3P0 = 0x78 }
	ssd1681 vcom enumeration definition More...
enum	ssd1681_otp_mode_t { SSD1681_OTP_MODE_NORMAL = 0x0 , SSD1681_OTP_MODE_INTERNAL = 0x3 }
	ssd1681 otp mode enumeration definition More...
enum	ssd1681_vbd_t { SSD1681_VBD_GS_TRANSITION = 0x0 , SSD1681_VBD_FIX_LEVEL = 0x1 , SSD1681_VBD_VCOM = 0x2 , SSD1681_VBD_HIZ = 0x3 }
	ssd1681 vbd enumeration definition More...
enum	ssd1681_vbd_fix_level_t { SSD1681_VBD_FIX_LEVEL_VSS = 0x0 , SSD1681_VBD_FIX_LEVEL_VSH1 = 0x1 , SSD1681_VBD_FIX_LEVEL_VSL = 0x2 , SSD1681_VBD_FIX_LEVEL_VSH2 = 0x3 }
	ssd1681 vbd fix level enumeration definition More...
enum	ssd1681_gs_transition_t { SSD1681_GS_TRANSITION_FOLLOW_LUT_RED = 0x0 , SSD1681_GS_TRANSITION_FOLLOW_LUT = 0x1 }
	ssd1681 gs transition enumeration definition More...
enum	ssd1681_vbd_transition_t { SSD1681_VBD_TRANSITION_LUT0 = 0x0 , SSD1681_VBD_TRANSITION_LUT1 = 0x1 , SSD1681_VBD_TRANSITION_LUT2 = 0x2 , SSD1681_VBD_TRANSITION_LUT3 = 0x3 }
	ssd1681 vbd transition enumeration definition More...
enum	ssd1681_end_opt_t { SSD1681_END_OPT_NORMAL = 0x22 , SSD1681_END_OPT_KEEP_BEFORE_OUTPUT = 0x07 }
	ssd1681 end opt enumeration definition More...
enum	ssd1681_read_ram_t { SSD1681_READ_RAM_BLACK = 0x0 , SSD1681_READ_RAM_RED = 0x1 }
	ssd1681 read ram enumeration definition More...
enum	ssd1681_step_height_t { SSD1681_STEP_HEIGHT_8 = 0x0 , SSD1681_STEP_HEIGHT_16 = 0x1 , SSD1681_STEP_HEIGHT_32 = 0x2 , SSD1681_STEP_HEIGHT_64 = 0x3 , SSD1681_STEP_HEIGHT_128 = 0x4 , SSD1681_STEP_HEIGHT_200 = 0x5 }
	ssd1681 step height enumeration definition More...
enum	ssd1681_step_width_t { SSD1681_STEP_WIDTH_8 = 0x0 , SSD1681_STEP_WIDTH_16 = 0x1 , SSD1681_STEP_WIDTH_32 = 0x2 , SSD1681_STEP_WIDTH_64 = 0x3 , SSD1681_STEP_WIDTH_128 = 0x4 , SSD1681_STEP_WIDTH_200 = 0x5 }
	ssd1681 step width enumeration definition More...
enum	ssd1681_color_t { SSD1681_COLOR_BLACK = 0x0 , SSD1681_COLOR_RED = 0x1 }
	ssd1681 color enumeration definition More...
enum	ssd1681_font_t { SSD1681_FONT_12 = 0x0C , SSD1681_FONT_16 = 0x10 , SSD1681_FONT_24 = 0x18 }
	ssd1681 font enumeration definition More...

Functions
uint8_t	ssd1681_info (ssd1681_info_t *info)
	get chip's information
uint8_t	ssd1681_init (ssd1681_handle_t *handle)
	initialize the chip
uint8_t	ssd1681_deinit (ssd1681_handle_t *handle)
	close the chip
uint8_t	ssd1681_clear (ssd1681_handle_t *handle, ssd1681_color_t color)
	clear the screen
uint8_t	ssd1681_gram_update (ssd1681_handle_t *handle, ssd1681_color_t color)
	update the gram data
uint8_t	ssd1681_gram_clear (ssd1681_handle_t *handle, ssd1681_color_t color)
	clear the screen in the gram
uint8_t	ssd1681_gram_write_point (ssd1681_handle_t *handle, ssd1681_color_t color, uint8_t x, uint8_t y, uint8_t data)
	write a point in the gram
uint8_t	ssd1681_gram_read_point (ssd1681_handle_t handle, ssd1681_color_t color, uint8_t x, uint8_t y, uint8_t data)
	read a point from the gram
uint8_t	ssd1681_gram_write_string (ssd1681_handle_t handle, ssd1681_color_t color, uint8_t x, uint8_t y, char str, uint16_t len, uint8_t data, ssd1681_font_t font)
	draw a string in the gram
uint8_t	ssd1681_gram_fill_rect (ssd1681_handle_t *handle, ssd1681_color_t color, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t data)
	fill a rectangle in the gram
uint8_t	ssd1681_gram_draw_picture (ssd1681_handle_t handle, ssd1681_color_t color, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t img)
	draw a picture in the gram
uint8_t	ssd1681_set_driver_output (ssd1681_handle_t *handle, uint16_t mux, ssd1681_bool_t gd, ssd1681_bool_t sm, ssd1681_bool_t tb)
	set the driver output
uint8_t	ssd1681_set_gate_driving_voltage (ssd1681_handle_t *handle, ssd1681_gate_driving_voltage_t voltage)
	set the gate driving voltage
uint8_t	ssd1681_set_source_driving_voltage (ssd1681_handle_t *handle, ssd1681_vsh_t vsh1, ssd1681_vsh_t vsh2, ssd1681_vsl_t vsl)
	set the source driving voltage
uint8_t	ssd1681_otp_initial (ssd1681_handle_t *handle)
	initial code setting otp program
uint8_t	ssd1681_otp_initial_write (ssd1681_handle_t *handle, uint8_t param[4])
	write register for initial code setting
uint8_t	ssd1681_otp_initial_read (ssd1681_handle_t *handle)
	read register for initial code setting
uint8_t	ssd1681_otp_program_vcom (ssd1681_handle_t *handle)
	program vcom otp
uint8_t	ssd1681_otp_read_register (ssd1681_handle_t *handle, uint8_t param[11])
	otp register read for display option
uint8_t	ssd1681_otp_program_waveform (ssd1681_handle_t *handle)
	program otp of waveform setting
uint8_t	ssd1681_otp_load_waveform (ssd1681_handle_t *handle)
	load otp of waveform setting
uint8_t	ssd1681_otp_program_selection (ssd1681_handle_t *handle)
	program otp selection
uint8_t	ssd1681_otp_write_register (ssd1681_handle_t *handle, uint8_t param[11])
	otp write register for display option
uint8_t	ssd1681_otp_program_mode (ssd1681_handle_t *handle, ssd1681_otp_mode_t mode)
	set the otp program mode
uint8_t	ssd1681_set_booster_soft_start (ssd1681_handle_t *handle, uint8_t phase1, uint8_t phase2, uint8_t phase3, uint8_t duration)
	set the booster soft start
uint8_t	ssd1681_set_mode (ssd1681_handle_t *handle, ssd1681_mode_t mode)
	set the mode
uint8_t	ssd1681_set_data_entry_mode (ssd1681_handle_t *handle, ssd1681_address_mode_t mode, ssd1681_address_direction_t direction)
	set the data entry mode
uint8_t	ssd1681_software_reset (ssd1681_handle_t *handle)
	software reset
uint8_t	ssd1681_set_hv_ready_detection (ssd1681_handle_t *handle, uint8_t cool_down_duration, uint8_t cool_down_loop_num)
	set the hv ready detection
uint8_t	ssd1681_set_vci_detection (ssd1681_handle_t *handle, ssd1681_vci_level_t level)
	set the vci detection
uint8_t	ssd1681_set_temperature_sensor (ssd1681_handle_t *handle, ssd1681_temperature_sensor_t sensor)
	set the temperature sensor
uint8_t	ssd1681_write_temperature_sensor (ssd1681_handle_t *handle, uint16_t control)
	write the temperature sensor
uint8_t	ssd1681_read_temperature_sensor (ssd1681_handle_t handle, uint16_t control)
	read the temperature sensor
uint8_t	ssd1681_write_temperature_sensor_ext (ssd1681_handle_t *handle, uint8_t param[3])
	write command to external temperature sensor
uint8_t	ssd1681_set_master_activate (ssd1681_handle_t *handle)
	master activate
uint8_t	ssd1681_set_display_update_control (ssd1681_handle_t *handle, ssd1681_display_control_t red_control, ssd1681_display_control_t black_control)
	set the display update control
uint8_t	ssd1681_set_display_sequence (ssd1681_handle_t *handle, ssd1681_display_sequence_t sequence)
	set the display sequence
uint8_t	ssd1681_set_black_ram (ssd1681_handle_t *handle)
	set the black ram
uint8_t	ssd1681_set_red_ram (ssd1681_handle_t *handle)
	set the red ram
uint8_t	ssd1681_get_ram (ssd1681_handle_t *handle)
	get the ram
uint8_t	ssd1681_set_enter_vcom_sense (ssd1681_handle_t *handle)
	set enter vcom sense
uint8_t	ssd1681_set_vcom_sense_duration (ssd1681_handle_t *handle, uint8_t duration)
	set the vcom sense duration
uint8_t	ssd1681_set_vcom_control_reg (ssd1681_handle_t *handle)
	write register for vcom control
uint8_t	ssd1681_set_vcom_register (ssd1681_handle_t *handle, ssd1681_vcom_t vcom)
	write vcom register
uint8_t	ssd1681_get_user_id (ssd1681_handle_t *handle, uint8_t id[10])
	get the user id
uint8_t	ssd1681_get_status (ssd1681_handle_t handle, uint8_t status)
	get the status
uint8_t	ssd1681_set_lut_register (ssd1681_handle_t handle, uint8_t reg, uint16_t len)
	set the lut register
uint8_t	ssd1681_set_crc_calculation (ssd1681_handle_t *handle)
	set the crc calculation
uint8_t	ssd1681_get_crc_status (ssd1681_handle_t handle, uint16_t status)
	get the crc status
uint8_t	ssd1681_set_user_id (ssd1681_handle_t *handle, uint8_t id[10])
	set the user id
uint8_t	ssd1681_set_border_waveform (ssd1681_handle_t *handle, ssd1681_vbd_t vbd, ssd1681_vbd_fix_level_t level, ssd1681_gs_transition_t gs_tran, ssd1681_vbd_transition_t vbd_tran)
	set the border waveform
uint8_t	ssd1681_set_end_option (ssd1681_handle_t *handle, ssd1681_end_opt_t opt)
	end option
uint8_t	ssd1681_set_read_ram (ssd1681_handle_t *handle, ssd1681_read_ram_t ram)
	set the read ram
uint8_t	ssd1681_set_ram_x (ssd1681_handle_t *handle, uint8_t start, uint8_t end)
	set the ram x range
uint8_t	ssd1681_set_ram_y (ssd1681_handle_t *handle, uint16_t start, uint16_t end)
	set the ram y range
uint8_t	ssd1681_set_auto_write_red_ram (ssd1681_handle_t *handle, ssd1681_step_height_t height, ssd1681_step_width_t width)
	set the auto write red ram
uint8_t	ssd1681_set_auto_write_black_ram (ssd1681_handle_t *handle, ssd1681_step_height_t height, ssd1681_step_width_t width)
	set the auto write black ram
uint8_t	ssd1681_set_ram_x_address_counter (ssd1681_handle_t *handle, uint8_t cnt)
	set the ram x address counter
uint8_t	ssd1681_set_ram_y_address_counter (ssd1681_handle_t *handle, uint16_t cnt)
	set the ram y address counter
uint8_t	ssd1681_nop (ssd1681_handle_t *handle)
	nop command

Detailed Description

ssd1681 base driver modules

Macro Definition Documentation

◆ SSD1681_BUSY_MAX_DELAY_MS

#define SSD1681_BUSY_MAX_DELAY_MS 10

ssd1681 busy max delay definition

10ms

Definition at line 63 of file driver_ssd1681.h.

◆ SSD1681_BUSY_MAX_RETRY_TIMES

#define SSD1681_BUSY_MAX_RETRY_TIMES 2000

ssd1681 busy max retry times definition

2000 times

Definition at line 70 of file driver_ssd1681.h.

Typedef Documentation

◆ ssd1681_handle_t

typedef struct ssd1681_handle_s ssd1681_handle_t

ssd1681 handle structure definition

◆ ssd1681_info_t

typedef struct ssd1681_info_s ssd1681_info_t

ssd1681 information structure definition

Enumeration Type Documentation

◆ ssd1681_address_direction_t

enum ssd1681_address_direction_t

ssd1681 address direction enumeration definition

Enumerator
SSD1681_ADDRESS_DIRECTION_UPDATED_X	the address counter is updated in the x direction
SSD1681_ADDRESS_DIRECTION_UPDATED_Y	the address counter is updated in the y direction

Definition at line 324 of file driver_ssd1681.h.

◆ ssd1681_address_mode_t

enum ssd1681_address_mode_t

ssd1681 address mode enumeration definition

Enumerator
SSD1681_ADDRESS_MODE_Y_DECREMENT_X_DECREMENT	y decrement, x decrement
SSD1681_ADDRESS_MODE_Y_DECREMENT_X_INCREMENT	y decrement, x increment
SSD1681_ADDRESS_MODE_Y_INCREMENT_X_DECREMENT	y increment, x decrement
SSD1681_ADDRESS_MODE_Y_INCREMENT_X_INCREMENT	y increment, x increment

Definition at line 313 of file driver_ssd1681.h.

◆ ssd1681_bool_t

enum ssd1681_bool_t

ssd1681 bool enumeration definition

Enumerator
SSD1681_BOOL_FALSE	false
SSD1681_BOOL_TRUE	true

Definition at line 76 of file driver_ssd1681.h.

◆ ssd1681_color_t

enum ssd1681_color_t

ssd1681 color enumeration definition

Enumerator
SSD1681_COLOR_BLACK	black color
SSD1681_COLOR_RED	red color

Definition at line 514 of file driver_ssd1681.h.

◆ ssd1681_display_control_t

enum ssd1681_display_control_t

ssd1681 display control enumeration definition

Enumerator
SSD1681_DISPLAY_CONTROL_NORMAL	normal
SSD1681_DISPLAY_CONTROL_BYPASS	bypass ram content as 0
SSD1681_DISPLAY_CONTROL_INVERSE	inverse ram content

Definition at line 354 of file driver_ssd1681.h.

◆ ssd1681_display_sequence_t

enum ssd1681_display_sequence_t

ssd1681 display sequence enumeration definition

Enumerator
SSD1681_DISPLAY_SEQUENCE_0	enable clock signal
SSD1681_DISPLAY_SEQUENCE_1	disable clock signal
SSD1681_DISPLAY_SEQUENCE_2	enable clock signal, enable analog
SSD1681_DISPLAY_SEQUENCE_3	disable analog, disable clock signal
SSD1681_DISPLAY_SEQUENCE_4	enable clock signal, load lut with display mode 1, disable clock signal
SSD1681_DISPLAY_SEQUENCE_5	enable clock signal, load lut with display mode 2, disable clock signal
SSD1681_DISPLAY_SEQUENCE_6	enable clock signal, load temperature value, load lut with display mode 1, disable clock signal
SSD1681_DISPLAY_SEQUENCE_7	enable clock signal, load temperature value, load lut with display mode 2, disable clock signal
SSD1681_DISPLAY_SEQUENCE_8	enable clock signal, enable analog, display with display mode 1, disable analog, disable osc
SSD1681_DISPLAY_SEQUENCE_9	enable clock signal, enable analog, display with display mode 2, disable analog, disable osc
SSD1681_DISPLAY_SEQUENCE_10	enable clock signal, enable analog, load temperature value, display with display mode 1, disable analog, disable osc
SSD1681_DISPLAY_SEQUENCE_11	enable clock signal, enable analog, load temperature value, display with display mode 2, disable analog, disable osc

Definition at line 364 of file driver_ssd1681.h.

◆ ssd1681_driving_strength_t

enum ssd1681_driving_strength_t

ssd1681 driving strength enumeration definition

Enumerator
SSD1681_DRIVING_STRENGTH_1	strength 1
SSD1681_DRIVING_STRENGTH_2	strength 2
SSD1681_DRIVING_STRENGTH_3	strength 3
SSD1681_DRIVING_STRENGTH_4	strength 4
SSD1681_DRIVING_STRENGTH_5	strength 5
SSD1681_DRIVING_STRENGTH_6	strength 6
SSD1681_DRIVING_STRENGTH_7	strength 7
SSD1681_DRIVING_STRENGTH_8	strength 8

Definition at line 258 of file driver_ssd1681.h.

◆ ssd1681_end_opt_t

enum ssd1681_end_opt_t

ssd1681 end opt enumeration definition

Enumerator
SSD1681_END_OPT_NORMAL	normal
SSD1681_END_OPT_KEEP_BEFORE_OUTPUT	source output level keep previous output before power off

Definition at line 470 of file driver_ssd1681.h.

◆ ssd1681_font_t

enum ssd1681_font_t

ssd1681 font enumeration definition

Enumerator
SSD1681_FONT_12	font 12
SSD1681_FONT_16	font 16
SSD1681_FONT_24	font 24

Definition at line 523 of file driver_ssd1681.h.

◆ ssd1681_gate_driving_voltage_t

enum ssd1681_gate_driving_voltage_t

ssd1681 gate driving voltage enumeration definition

Enumerator
SSD1681_GATE_DRIVING_VOLTAGE_10V	10V
SSD1681_GATE_DRIVING_VOLTAGE_10P5V	10.5V
SSD1681_GATE_DRIVING_VOLTAGE_11V	11V
SSD1681_GATE_DRIVING_VOLTAGE_11P5V	11.5V
SSD1681_GATE_DRIVING_VOLTAGE_12V	12V
SSD1681_GATE_DRIVING_VOLTAGE_12P5V	12.5V
SSD1681_GATE_DRIVING_VOLTAGE_13V	13V
SSD1681_GATE_DRIVING_VOLTAGE_13P5V	13.5V
SSD1681_GATE_DRIVING_VOLTAGE_14V	14V
SSD1681_GATE_DRIVING_VOLTAGE_14P5V	14.5V
SSD1681_GATE_DRIVING_VOLTAGE_15V	15V
SSD1681_GATE_DRIVING_VOLTAGE_15P5V	15.5V
SSD1681_GATE_DRIVING_VOLTAGE_16V	16V
SSD1681_GATE_DRIVING_VOLTAGE_16P5V	16.5V
SSD1681_GATE_DRIVING_VOLTAGE_17V	17V
SSD1681_GATE_DRIVING_VOLTAGE_17P5V	17.5V
SSD1681_GATE_DRIVING_VOLTAGE_18V	18V
SSD1681_GATE_DRIVING_VOLTAGE_18P5V	18.5V
SSD1681_GATE_DRIVING_VOLTAGE_19V	19V
SSD1681_GATE_DRIVING_VOLTAGE_19P5V	19.5V
SSD1681_GATE_DRIVING_VOLTAGE_20V	20V

Definition at line 85 of file driver_ssd1681.h.

◆ ssd1681_gs_transition_t

enum ssd1681_gs_transition_t

ssd1681 gs transition enumeration definition

Enumerator
SSD1681_GS_TRANSITION_FOLLOW_LUT_RED	follow lut red
SSD1681_GS_TRANSITION_FOLLOW_LUT	follow lut

Definition at line 450 of file driver_ssd1681.h.

◆ ssd1681_min_off_time_t

enum ssd1681_min_off_time_t

ssd1681 min off time enumeration definition

Enumerator
SSD1681_MIN_OFF_TIME_2P6	2.6 time unit
SSD1681_MIN_OFF_TIME_3P2	3.2 time unit
SSD1681_MIN_OFF_TIME_3P9	3.9 time unit
SSD1681_MIN_OFF_TIME_4P6	4.6 time unit
SSD1681_MIN_OFF_TIME_5P4	5.4 time unit
SSD1681_MIN_OFF_TIME_6P3	6.3 time unit
SSD1681_MIN_OFF_TIME_7P3	7.3 time unit
SSD1681_MIN_OFF_TIME_8P4	8.4 time unit
SSD1681_MIN_OFF_TIME_9P8	9.8 time unit
SSD1681_MIN_OFF_TIME_11P5	11.5 time unit
SSD1681_MIN_OFF_TIME_13P8	13.8 time unit
SSD1681_MIN_OFF_TIME_16P5	16.5 time unit

Definition at line 273 of file driver_ssd1681.h.

◆ ssd1681_mode_t

enum ssd1681_mode_t

ssd1681 mode enumeration definition

Enumerator
SSD1681_MODE_NORMAL	normal mode
SSD1681_MODE_DEEP_SLEEP_1	enter deep sleep mode 1
SSD1681_MODE_DEEP_SLEEP_2	enter deep sleep mode 2

Definition at line 303 of file driver_ssd1681.h.

◆ ssd1681_otp_mode_t

enum ssd1681_otp_mode_t

ssd1681 otp mode enumeration definition

Enumerator
SSD1681_OTP_MODE_NORMAL	normal mode
SSD1681_OTP_MODE_INTERNAL	internal generated otp programming voltage

Definition at line 419 of file driver_ssd1681.h.

◆ ssd1681_phase_duration_t

enum ssd1681_phase_duration_t

ssd1681 phase duration enumeration definition

Enumerator
SSD1681_PHASE_DURATION_10MS	10ms
SSD1681_PHASE_DURATION_20MS	20ms
SSD1681_PHASE_DURATION_30MS	30ms
SSD1681_PHASE_DURATION_40MS	40ms

Definition at line 292 of file driver_ssd1681.h.

◆ ssd1681_read_ram_t

enum ssd1681_read_ram_t

ssd1681 read ram enumeration definition

Enumerator
SSD1681_READ_RAM_BLACK	black
SSD1681_READ_RAM_RED	red

Definition at line 479 of file driver_ssd1681.h.

◆ ssd1681_step_height_t

enum ssd1681_step_height_t

ssd1681 step height enumeration definition

Enumerator
SSD1681_STEP_HEIGHT_8	height 8
SSD1681_STEP_HEIGHT_16	height 16
SSD1681_STEP_HEIGHT_32	height 32
SSD1681_STEP_HEIGHT_64	height 64
SSD1681_STEP_HEIGHT_128	height 128
SSD1681_STEP_HEIGHT_200	height 200

Definition at line 488 of file driver_ssd1681.h.

◆ ssd1681_step_width_t

enum ssd1681_step_width_t

ssd1681 step width enumeration definition

Enumerator
SSD1681_STEP_WIDTH_8	width 8
SSD1681_STEP_WIDTH_16	width 16
SSD1681_STEP_WIDTH_32	width 32
SSD1681_STEP_WIDTH_64	width 64
SSD1681_STEP_WIDTH_128	width 128
SSD1681_STEP_WIDTH_200	width 200

Definition at line 501 of file driver_ssd1681.h.

◆ ssd1681_temperature_sensor_t

enum ssd1681_temperature_sensor_t

ssd1681 temperature sensor enumeration definition

Enumerator
SSD1681_TEMPERATURE_SENSOR_EXTERNAL	external temperature sensor
SSD1681_TEMPERATURE_SENSOR_INTERNAL	internal temperature sensor

Definition at line 345 of file driver_ssd1681.h.

◆ ssd1681_vbd_fix_level_t

enum ssd1681_vbd_fix_level_t

ssd1681 vbd fix level enumeration definition

Enumerator
SSD1681_VBD_FIX_LEVEL_VSS	vss
SSD1681_VBD_FIX_LEVEL_VSH1	vsh1
SSD1681_VBD_FIX_LEVEL_VSL	vsl
SSD1681_VBD_FIX_LEVEL_VSH2	vsh2

Definition at line 439 of file driver_ssd1681.h.

◆ ssd1681_vbd_t

enum ssd1681_vbd_t

ssd1681 vbd enumeration definition

Enumerator
SSD1681_VBD_GS_TRANSITION	gs transition
SSD1681_VBD_FIX_LEVEL	fix level,
SSD1681_VBD_VCOM	vcom
SSD1681_VBD_HIZ	hiz

Definition at line 428 of file driver_ssd1681.h.

◆ ssd1681_vbd_transition_t

enum ssd1681_vbd_transition_t

ssd1681 vbd transition enumeration definition

Enumerator
SSD1681_VBD_TRANSITION_LUT0	lut0
SSD1681_VBD_TRANSITION_LUT1	lut1
SSD1681_VBD_TRANSITION_LUT2	lut2
SSD1681_VBD_TRANSITION_LUT3	lut3

Definition at line 459 of file driver_ssd1681.h.

◆ ssd1681_vci_level_t

enum ssd1681_vci_level_t

ssd1681 vci level enumeration definition

Enumerator
SSD1681_VCI_LEVEL_2P2V	2.2V
SSD1681_VCI_LEVEL_2P3V	2.3V
SSD1681_VCI_LEVEL_2P4V	2.4V
SSD1681_VCI_LEVEL_2P5V	2.5V
SSD1681_VCI_LEVEL_2P6V	2.6V

Definition at line 333 of file driver_ssd1681.h.

◆ ssd1681_vcom_t

enum ssd1681_vcom_t

ssd1681 vcom enumeration definition

Enumerator
SSD1681_VCOM_NEGATIVE_0P2	-0.2
SSD1681_VCOM_NEGATIVE_0P3	-0.3
SSD1681_VCOM_NEGATIVE_0P4	-0.4
SSD1681_VCOM_NEGATIVE_0P5	-0.5
SSD1681_VCOM_NEGATIVE_0P6	-0.6
SSD1681_VCOM_NEGATIVE_0P7	-0.7
SSD1681_VCOM_NEGATIVE_0P8	-0.8
SSD1681_VCOM_NEGATIVE_0P9	-0.9
SSD1681_VCOM_NEGATIVE_1P0	-1.0
SSD1681_VCOM_NEGATIVE_1P1	-1.1
SSD1681_VCOM_NEGATIVE_1P2	-1.2
SSD1681_VCOM_NEGATIVE_1P3	-1.3
SSD1681_VCOM_NEGATIVE_1P4	-1.4
SSD1681_VCOM_NEGATIVE_1P5	-1.5
SSD1681_VCOM_NEGATIVE_1P6	-1.6
SSD1681_VCOM_NEGATIVE_1P7	-1.7
SSD1681_VCOM_NEGATIVE_1P8	-1.8
SSD1681_VCOM_NEGATIVE_1P9	-1.9
SSD1681_VCOM_NEGATIVE_2P0	-2.0
SSD1681_VCOM_NEGATIVE_2P1	-2.1
SSD1681_VCOM_NEGATIVE_2P2	-2.2
SSD1681_VCOM_NEGATIVE_2P3	-2.3
SSD1681_VCOM_NEGATIVE_2P4	-2.4
SSD1681_VCOM_NEGATIVE_2P5	-2.5
SSD1681_VCOM_NEGATIVE_2P6	-2.6
SSD1681_VCOM_NEGATIVE_2P7	-2.7
SSD1681_VCOM_NEGATIVE_2P8	-2.8
SSD1681_VCOM_NEGATIVE_2P9	-2.9
SSD1681_VCOM_NEGATIVE_3P0	-3.0

Definition at line 383 of file driver_ssd1681.h.

◆ ssd1681_vsh_t

enum ssd1681_vsh_t

ssd1681 vsh enumeration definition

Enumerator
SSD1681_VSH_2P4V	2.4V
SSD1681_VSH_2P5V	2.5V
SSD1681_VSH_2P6V	2.6V
SSD1681_VSH_2P7V	2.7V
SSD1681_VSH_2P8V	2.8V
SSD1681_VSH_2P9V	2.9V
SSD1681_VSH_3V	3V
SSD1681_VSH_3P1V	3.1V
SSD1681_VSH_3P2V	3.2V
SSD1681_VSH_3P3V	3.3V
SSD1681_VSH_3P4V	3.4V
SSD1681_VSH_3P5V	3.5V
SSD1681_VSH_3P6V	3.6V
SSD1681_VSH_3P7V	3.7V
SSD1681_VSH_3P8V	3.8V
SSD1681_VSH_3P9V	3.9V
SSD1681_VSH_4V	4V
SSD1681_VSH_4P1V	4.1V
SSD1681_VSH_4P2V	4.2V
SSD1681_VSH_4P3V	4.3V
SSD1681_VSH_4P4V	4.4V
SSD1681_VSH_4P5V	4.5V
SSD1681_VSH_4P6V	4.6V
SSD1681_VSH_4P7V	4.7V
SSD1681_VSH_4P8V	4.8V
SSD1681_VSH_4P9V	4.9V
SSD1681_VSH_5V	5V
SSD1681_VSH_5P1V	5.1V
SSD1681_VSH_5P2V	5.2V
SSD1681_VSH_5P3V	5.3V
SSD1681_VSH_5P4V	5.4V
SSD1681_VSH_5P5V	5.5V
SSD1681_VSH_5P6V	5.6V
SSD1681_VSH_5P7V	5.7V
SSD1681_VSH_5P8V	5.8V
SSD1681_VSH_5P9V	5.9V
SSD1681_VSH_6V	6V
SSD1681_VSH_6P1V	6.1V
SSD1681_VSH_6P2V	6.2V
SSD1681_VSH_6P3V	6.3V
SSD1681_VSH_6P4V	6.4V
SSD1681_VSH_6P5V	6.5V
SSD1681_VSH_6P6V	6.6V
SSD1681_VSH_6P7V	6.7V
SSD1681_VSH_6P8V	6.8V
SSD1681_VSH_6P9V	6.9V
SSD1681_VSH_7V	7V
SSD1681_VSH_7P1V	7.1V
SSD1681_VSH_7P2V	7.2V
SSD1681_VSH_7P3V	7.3V
SSD1681_VSH_7P4V	7.4V
SSD1681_VSH_7P5V	7.5V
SSD1681_VSH_7P6V	7.6V
SSD1681_VSH_7P7V	7.7V
SSD1681_VSH_7P8V	7.8V
SSD1681_VSH_7P9V	7.9V
SSD1681_VSH_8V	8V
SSD1681_VSH_8P1V	8.1V
SSD1681_VSH_8P2V	8.2V
SSD1681_VSH_8P3V	8.3V
SSD1681_VSH_8P4V	8.4V
SSD1681_VSH_8P5V	8.5V
SSD1681_VSH_8P6V	8.6V
SSD1681_VSH_8P7V	8.7V
SSD1681_VSH_8P8V	8.8V
SSD1681_VSH_9V	9V
SSD1681_VSH_9P2V	9.2V
SSD1681_VSH_9P4V	9.4V
SSD1681_VSH_9P6V	9.6V
SSD1681_VSH_9P8V	9.8V
SSD1681_VSH_10V	10V
SSD1681_VSH_10P2V	10.2V
SSD1681_VSH_10P4V	10.4V
SSD1681_VSH_10P6V	10.6V
SSD1681_VSH_10P8V	10.8V
SSD1681_VSH_11V	11V
SSD1681_VSH_11P2V	11.2V
SSD1681_VSH_11P4V	11.4V
SSD1681_VSH_11P6V	11.6V
SSD1681_VSH_11P8V	11.8V
SSD1681_VSH_12V	12V
SSD1681_VSH_12P2V	12.2V
SSD1681_VSH_12P4V	12.4V
SSD1681_VSH_12P6V	12.6V
SSD1681_VSH_12P8V	12.8V
SSD1681_VSH_13V	13V
SSD1681_VSH_13P2V	13.2V
SSD1681_VSH_13P4V	13.4V
SSD1681_VSH_13P6V	13.6V
SSD1681_VSH_13P8V	13.8V
SSD1681_VSH_14V	14V
SSD1681_VSH_14P2V	14.2V
SSD1681_VSH_14P4V	14.4V
SSD1681_VSH_14P6V	14.6V
SSD1681_VSH_14P8V	14.8V
SSD1681_VSH_15V	15V
SSD1681_VSH_15P2V	15.2V
SSD1681_VSH_15P4V	15.4V
SSD1681_VSH_15P6V	15.6V
SSD1681_VSH_15P8V	15.8V
SSD1681_VSH_16V	16V
SSD1681_VSH_16P2V	16.2V
SSD1681_VSH_16P4V	16.4V
SSD1681_VSH_16P6V	16.6V
SSD1681_VSH_16P8V	16.8V
SSD1681_VSH_17V	17V

Definition at line 113 of file driver_ssd1681.h.

◆ ssd1681_vsl_t

enum ssd1681_vsl_t

ssd1681 vsl enumeration definition

Enumerator
SSD1681_VSL_NEGATIVE_5	-5
SSD1681_VSL_NEGATIVE_5P5	-5.5
SSD1681_VSL_NEGATIVE_6	-6
SSD1681_VSL_NEGATIVE_6P5	-6.5
SSD1681_VSL_NEGATIVE_7	-7
SSD1681_VSL_NEGATIVE_7P5	-7.5
SSD1681_VSL_NEGATIVE_8	-8
SSD1681_VSL_NEGATIVE_8P5	-8.5
SSD1681_VSL_NEGATIVE_9	-9
SSD1681_VSL_NEGATIVE_9P5	-9.5
SSD1681_VSL_NEGATIVE_10	-10
SSD1681_VSL_NEGATIVE_10P5	-10.5
SSD1681_VSL_NEGATIVE_11	-11
SSD1681_VSL_NEGATIVE_11P5	-11.5
SSD1681_VSL_NEGATIVE_12	-12
SSD1681_VSL_NEGATIVE_12P5	-12.5
SSD1681_VSL_NEGATIVE_13	-13
SSD1681_VSL_NEGATIVE_13P5	-13.5
SSD1681_VSL_NEGATIVE_14	-14
SSD1681_VSL_NEGATIVE_14P5	-14.5
SSD1681_VSL_NEGATIVE_15	-15
SSD1681_VSL_NEGATIVE_15P5	-15.5
SSD1681_VSL_NEGATIVE_16	-16
SSD1681_VSL_NEGATIVE_16P5	-16.5
SSD1681_VSL_NEGATIVE_17	-17

Definition at line 226 of file driver_ssd1681.h.

Function Documentation

◆ ssd1681_clear()

uint8_t ssd1681_clear	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color )

clear the screen

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type

Returns

status code

0 success
1 clear failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2241 of file driver_ssd1681.c.

◆ ssd1681_deinit()

uint8_t ssd1681_deinit ( ssd1681_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 spi deinit failed
2 handle is NULL
3 handle is not initialized
4 power down failed
5 reset gpio deinit failed
6 command && data deinit failed
7 busy gpio deinit failed

Note: none

Definition at line 3019 of file driver_ssd1681.c.

◆ ssd1681_get_crc_status()

uint8_t ssd1681_get_crc_status	(	ssd1681_handle_t *	handle,
		uint16_t *	status )

get the crc status

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get crc status failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1538 of file driver_ssd1681.c.

◆ ssd1681_get_ram()

uint8_t ssd1681_get_ram ( ssd1681_handle_t * handle )

get the ram

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 get ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1081 of file driver_ssd1681.c.

◆ ssd1681_get_status()

uint8_t ssd1681_get_status	(	ssd1681_handle_t *	handle,
		uint8_t *	status )

get the status

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get status failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1365 of file driver_ssd1681.c.

◆ ssd1681_get_user_id()

uint8_t ssd1681_get_user_id	(	ssd1681_handle_t *	handle,
		uint8_t	id[10] )

get the user id

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[out]	*id	pointer to an id buffer

Returns

status code

0 success
1 get user id failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1330 of file driver_ssd1681.c.

◆ ssd1681_gram_clear()

uint8_t ssd1681_gram_clear	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color )

clear the screen in the gram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type

Returns

status code

0 success
1 clear failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2491 of file driver_ssd1681.c.

◆ ssd1681_gram_draw_picture()

uint8_t ssd1681_gram_draw_picture	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color,
		uint8_t	left,
		uint8_t	top,
		uint8_t	right,
		uint8_t	bottom,
		uint8_t *	img )

draw a picture in the gram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type
[in]	left	left coordinate x
[in]	top	top coordinate y
[in]	right	right coordinate x
[in]	bottom	bottom coordinate y
[in]	*img	pointer to an image buffer

Returns

status code

0 success
1 gram draw picture failed
2 handle is NULL
3 handle is not initialized
4 left or top is invalid
5 right or bottom is invalid
6 left > right or top > bottom

Note: none

Definition at line 2800 of file driver_ssd1681.c.

◆ ssd1681_gram_fill_rect()

uint8_t ssd1681_gram_fill_rect	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color,
		uint8_t	left,
		uint8_t	top,
		uint8_t	right,
		uint8_t	bottom,
		uint8_t	data )

fill a rectangle in the gram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type
[in]	left	left coordinate x
[in]	top	top coordinate y
[in]	right	right coordinate x
[in]	bottom	bottom coordinate y
[in]	data	display color

Returns

status code

0 success
1 gram fill rect failed
2 handle is NULL
3 handle is not initialized
4 left or top is invalid
5 right or bottom is invalid
6 left > right or top > bottom

Note: none

Definition at line 2736 of file driver_ssd1681.c.

◆ ssd1681_gram_read_point()

uint8_t ssd1681_gram_read_point	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color,
		uint8_t	x,
		uint8_t	y,
		uint8_t *	data )

read a point from the gram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type
[in]	x	coordinate x
[in]	y	coordinate y
[out]	*data	pointer to a data buffer

Returns

status code

0 success
1 gram read point failed
2 handle is NULL
3 handle is not initialized
4 x or y is invalid

Note: none

Definition at line 2609 of file driver_ssd1681.c.

◆ ssd1681_gram_update()

uint8_t ssd1681_gram_update	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color )

update the gram data

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type

Returns

status code

0 success
1 gram update failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2367 of file driver_ssd1681.c.

◆ ssd1681_gram_write_point()

uint8_t ssd1681_gram_write_point	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color,
		uint8_t	x,
		uint8_t	y,
		uint8_t	data )

write a point in the gram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type
[in]	x	coordinate x
[in]	y	coordinate y
[in]	data	written data

Returns

status code

0 success
1 gram write point failed
2 handle is NULL
3 handle is not initialized
4 x or y is invalid

Note: none

Definition at line 2544 of file driver_ssd1681.c.

◆ ssd1681_gram_write_string()

uint8_t ssd1681_gram_write_string	(	ssd1681_handle_t *	handle,
		ssd1681_color_t	color,
		uint8_t	x,
		uint8_t	y,
		char *	str,
		uint16_t	len,
		uint8_t	data,
		ssd1681_font_t	font )

draw a string in the gram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	color	color type
[in]	x	coordinate x
[in]	y	coordinate y
[in]	*str	pointer to a write string address
[in]	len	length of the string
[in]	data	display color
[in]	font	display font size

Returns

status code

0 success
1 gram write string failed
2 handle is NULL
3 handle is not initialized
4 x or y is invalid

Note: none

Definition at line 2677 of file driver_ssd1681.c.

◆ ssd1681_info()

uint8_t ssd1681_info ( ssd1681_info_t * info )

get chip's information

Parameters

[out] *info pointer to an ssd1681 info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 3208 of file driver_ssd1681.c.

◆ ssd1681_init()

uint8_t ssd1681_init ( ssd1681_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 spi initialization failed
2 handle is NULL
3 linked functions is NULL
4 reset failed
5 gpio init failed

Note: none

Definition at line 2858 of file driver_ssd1681.c.

◆ ssd1681_nop()

uint8_t ssd1681_nop ( ssd1681_handle_t * handle )

nop command

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 nop failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2089 of file driver_ssd1681.c.

◆ ssd1681_otp_initial()

uint8_t ssd1681_otp_initial ( ssd1681_handle_t * handle )

initial code setting otp program

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 otp initial failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 402 of file driver_ssd1681.c.

◆ ssd1681_otp_initial_read()

uint8_t ssd1681_otp_initial_read ( ssd1681_handle_t * handle )

read register for initial code setting

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 otp initial read failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 471 of file driver_ssd1681.c.

◆ ssd1681_otp_initial_write()

uint8_t ssd1681_otp_initial_write	(	ssd1681_handle_t *	handle,
		uint8_t	param[4] )

write register for initial code setting

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	*param	pointer to a param buffer

Returns

status code

0 success
1 otp initial write failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 437 of file driver_ssd1681.c.

◆ ssd1681_otp_load_waveform()

uint8_t ssd1681_otp_load_waveform ( ssd1681_handle_t * handle )

load otp of waveform setting

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 otp load waveform failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1433 of file driver_ssd1681.c.

◆ ssd1681_otp_program_mode()

uint8_t ssd1681_otp_program_mode	(	ssd1681_handle_t *	handle,
		ssd1681_otp_mode_t	mode )

set the otp program mode

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	mode	otp mode

Returns

status code

0 success
1 otp program mode failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1679 of file driver_ssd1681.c.

◆ ssd1681_otp_program_selection()

uint8_t ssd1681_otp_program_selection ( ssd1681_handle_t * handle )

program otp selection

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 otp program selection failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1574 of file driver_ssd1681.c.

◆ ssd1681_otp_program_vcom()

uint8_t ssd1681_otp_program_vcom ( ssd1681_handle_t * handle )

program vcom otp

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 otp program vcom failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1186 of file driver_ssd1681.c.

◆ ssd1681_otp_program_waveform()

uint8_t ssd1681_otp_program_waveform ( ssd1681_handle_t * handle )

program otp of waveform setting

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 otp program waveform failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1399 of file driver_ssd1681.c.

◆ ssd1681_otp_read_register()

uint8_t ssd1681_otp_read_register	(	ssd1681_handle_t *	handle,
		uint8_t	param[11] )

otp register read for display option

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[out]	*param	pointer to a param buffer

Returns

status code

0 success
1 otp read register failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1295 of file driver_ssd1681.c.

◆ ssd1681_otp_write_register()

uint8_t ssd1681_otp_write_register	(	ssd1681_handle_t *	handle,
		uint8_t	param[11] )

otp write register for display option

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	*param	pointer to a param buffer

Returns

status code

0 success
1 otp write register failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1609 of file driver_ssd1681.c.

◆ ssd1681_read_temperature_sensor()

uint8_t ssd1681_read_temperature_sensor	(	ssd1681_handle_t *	handle,
		uint16_t *	control )

read the temperature sensor

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[out]	*control	pointer to a control buffer

Returns

status code

0 success
1 read temperature sensor failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 833 of file driver_ssd1681.c.

◆ ssd1681_set_auto_write_black_ram()

uint8_t ssd1681_set_auto_write_black_ram	(	ssd1681_handle_t *	handle,
		ssd1681_step_height_t	height,
		ssd1681_step_width_t	width )

set the auto write black ram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	height	step height
[in]	width	step width

Returns

status code

0 success
1 set auto write black ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1964 of file driver_ssd1681.c.

◆ ssd1681_set_auto_write_red_ram()

uint8_t ssd1681_set_auto_write_red_ram	(	ssd1681_handle_t *	handle,
		ssd1681_step_height_t	height,
		ssd1681_step_width_t	width )

set the auto write red ram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	height	step height
[in]	width	step width

Returns

status code

0 success
1 set auto write red ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1926 of file driver_ssd1681.c.

◆ ssd1681_set_black_ram()

uint8_t ssd1681_set_black_ram ( ssd1681_handle_t * handle )

set the black ram

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 set black ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1013 of file driver_ssd1681.c.

◆ ssd1681_set_booster_soft_start()

uint8_t ssd1681_set_booster_soft_start	(	ssd1681_handle_t *	handle,
		uint8_t	phase1,
		uint8_t	phase2,
		uint8_t	phase3,
		uint8_t	duration )

set the booster soft start

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	phase1	phase 1
[in]	phase2	phase 2
[in]	phase3	phase 3
[in]	duration	phase duration

Returns

status code

0 success
1 set booster soft start failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 509 of file driver_ssd1681.c.

◆ ssd1681_set_border_waveform()

uint8_t ssd1681_set_border_waveform	(	ssd1681_handle_t *	handle,
		ssd1681_vbd_t	vbd,
		ssd1681_vbd_fix_level_t	level,
		ssd1681_gs_transition_t	gs_tran,
		ssd1681_vbd_transition_t	vbd_tran )

set the border waveform

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	vbd	select vbd option
[in]	level	fix level setting for vbd
[in]	gs_tran	gs transition control
[in]	vbd_tran	gs transition setting for vbd

Returns

status code

0 success
1 set border waveform failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1719 of file driver_ssd1681.c.

◆ ssd1681_set_crc_calculation()

uint8_t ssd1681_set_crc_calculation ( ssd1681_handle_t * handle )

set the crc calculation

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 set crc calculation failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1503 of file driver_ssd1681.c.

◆ ssd1681_set_data_entry_mode()

uint8_t ssd1681_set_data_entry_mode	(	ssd1681_handle_t *	handle,
		ssd1681_address_mode_t	mode,
		ssd1681_address_direction_t	direction )

set the data entry mode

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	mode	address mode
[in]	direction	address direction

Returns

status code

0 success
1 set data entry mode failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 589 of file driver_ssd1681.c.

◆ ssd1681_set_display_sequence()

uint8_t ssd1681_set_display_sequence	(	ssd1681_handle_t *	handle,
		ssd1681_display_sequence_t	sequence )

set the display sequence

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	sequence	display sequence

Returns

status code

0 success
1 set display sequence failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 977 of file driver_ssd1681.c.

◆ ssd1681_set_display_update_control()

uint8_t ssd1681_set_display_update_control	(	ssd1681_handle_t *	handle,
		ssd1681_display_control_t	red_control,
		ssd1681_display_control_t	black_control )

set the display update control

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	red_control	red control
[in]	black_control	black control

Returns

status code

0 success
1 set display update control failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 940 of file driver_ssd1681.c.

◆ ssd1681_set_driver_output()

uint8_t ssd1681_set_driver_output	(	ssd1681_handle_t *	handle,
		uint16_t	mux,
		ssd1681_bool_t	gd,
		ssd1681_bool_t	sm,
		ssd1681_bool_t	tb )

set the driver output

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	mux	set mux
[in]	gd	bool value
[in]	sm	bool value
[in]	tb	bool value

Returns

status code

0 success
1 set driver output failed
2 handle is NULL
3 handle is not initialized
4 mux is invalid

Note: mux can't be over 0x1FF

Definition at line 265 of file driver_ssd1681.c.

◆ ssd1681_set_end_option()

uint8_t ssd1681_set_end_option	(	ssd1681_handle_t *	handle,
		ssd1681_end_opt_t	opt )

end option

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	opt	end option

Returns

status code

0 success
1 set end option failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1757 of file driver_ssd1681.c.

◆ ssd1681_set_enter_vcom_sense()

uint8_t ssd1681_set_enter_vcom_sense ( ssd1681_handle_t * handle )

set enter vcom sense

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 set enter vcom sense failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1115 of file driver_ssd1681.c.

◆ ssd1681_set_gate_driving_voltage()

uint8_t ssd1681_set_gate_driving_voltage	(	ssd1681_handle_t *	handle,
		ssd1681_gate_driving_voltage_t	voltage )

set the gate driving voltage

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	voltage	gate driving voltage

Returns

status code

0 success
1 set gate driving voltage failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 325 of file driver_ssd1681.c.

◆ ssd1681_set_hv_ready_detection()

uint8_t ssd1681_set_hv_ready_detection	(	ssd1681_handle_t *	handle,
		uint8_t	cool_down_duration,
		uint8_t	cool_down_loop_num )

set the hv ready detection

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	cool_down_duration	cool down duration
[in]	cool_down_loop_num	cool down loop num

Returns

status code

0 success
1 set hv ready detection failed
2 handle is NULL
3 handle is not initialized
4 cool_down_duration is over 7
5 cool_down_loop_num is over 7

Note: cool_down_duration <= 7 cool_down_loop_num <= 7 duration = 10ms x (cool_down_duration + 1)

Definition at line 665 of file driver_ssd1681.c.

◆ ssd1681_set_lut_register()

uint8_t ssd1681_set_lut_register	(	ssd1681_handle_t *	handle,
		uint8_t *	reg,
		uint16_t	len )

set the lut register

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	*reg	pointer to a register buffer
[in]	len	register length

Returns

status code

0 success
1 set lut register failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1469 of file driver_ssd1681.c.

◆ ssd1681_set_master_activate()

uint8_t ssd1681_set_master_activate ( ssd1681_handle_t * handle )

master activate

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 set master activate failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 904 of file driver_ssd1681.c.

◆ ssd1681_set_mode()

uint8_t ssd1681_set_mode	(	ssd1681_handle_t *	handle,
		ssd1681_mode_t	mode )

set the mode

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	mode	set mode

Returns

status code

0 success
1 set mode failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 551 of file driver_ssd1681.c.

◆ ssd1681_set_ram_x()

uint8_t ssd1681_set_ram_x	(	ssd1681_handle_t *	handle,
		uint8_t	start,
		uint8_t	end )

set the ram x range

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	start	start address
[in]	end	end address

Returns

status code

0 success
1 set ram x failed
2 handle is NULL
3 handle is not initialized
4 start > 0x3F
5 end > 0x3F

Note: none

Definition at line 1834 of file driver_ssd1681.c.

◆ ssd1681_set_ram_x_address_counter()

uint8_t ssd1681_set_ram_x_address_counter	(	ssd1681_handle_t *	handle,
		uint8_t	cnt )

set the ram x address counter

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	cnt	address counter

Returns

status code

0 success
1 set ram x address counter failed
2 handle is NULL
3 handle is not initialized
4 cnt > 0x3F

Note: none

Definition at line 2002 of file driver_ssd1681.c.

◆ ssd1681_set_ram_y()

uint8_t ssd1681_set_ram_y	(	ssd1681_handle_t *	handle,
		uint16_t	start,
		uint16_t	end )

set the ram y range

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	start	start address
[in]	end	end address

Returns

status code

0 success
1 set ram y failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1885 of file driver_ssd1681.c.

◆ ssd1681_set_ram_y_address_counter()

uint8_t ssd1681_set_ram_y_address_counter	(	ssd1681_handle_t *	handle,
		uint16_t	cnt )

set the ram y address counter

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	cnt	address counter

Returns

status code

0 success
1 set ram y address counter failed
2 handle is NULL
3 handle is not initialized
4 cnt > 0x1FF

Note: none

Definition at line 2046 of file driver_ssd1681.c.

◆ ssd1681_set_read_ram()

uint8_t ssd1681_set_read_ram	(	ssd1681_handle_t *	handle,
		ssd1681_read_ram_t	ram )

set the read ram

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	ram	read ram option

Returns

status code

0 success
1 set read ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1794 of file driver_ssd1681.c.

◆ ssd1681_set_red_ram()

uint8_t ssd1681_set_red_ram ( ssd1681_handle_t * handle )

set the red ram

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 set red ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1047 of file driver_ssd1681.c.

◆ ssd1681_set_source_driving_voltage()

uint8_t ssd1681_set_source_driving_voltage	(	ssd1681_handle_t *	handle,
		ssd1681_vsh_t	vsh1,
		ssd1681_vsh_t	vsh2,
		ssd1681_vsl_t	vsl )

set the source driving voltage

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	vsh1	set vsh1
[in]	vsh2	set vsh2
[in]	vsl	set vsl

Returns

status code

0 success
1 set source driving voltage failed
2 handle is NULL
3 handle is not initialized

Note: vsh1 >= vsh2

Definition at line 364 of file driver_ssd1681.c.

◆ ssd1681_set_temperature_sensor()

uint8_t ssd1681_set_temperature_sensor	(	ssd1681_handle_t *	handle,
		ssd1681_temperature_sensor_t	sensor )

set the temperature sensor

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	sensor	temperature sensor

Returns

status code

0 success
1 set temperature sensor failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 751 of file driver_ssd1681.c.

◆ ssd1681_set_user_id()

uint8_t ssd1681_set_user_id	(	ssd1681_handle_t *	handle,
		uint8_t	id[10] )

set the user id

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	*id	pointer to an id buffer

Returns

status code

0 success
1 set user id failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1644 of file driver_ssd1681.c.

◆ ssd1681_set_vci_detection()

uint8_t ssd1681_set_vci_detection	(	ssd1681_handle_t *	handle,
		ssd1681_vci_level_t	level )

set the vci detection

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	level	vci level

Returns

status code

0 success
1 set vci detection failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 714 of file driver_ssd1681.c.

◆ ssd1681_set_vcom_control_reg()

uint8_t ssd1681_set_vcom_control_reg ( ssd1681_handle_t * handle )

write register for vcom control

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 set vcom control reg failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1220 of file driver_ssd1681.c.

◆ ssd1681_set_vcom_register()

uint8_t ssd1681_set_vcom_register	(	ssd1681_handle_t *	handle,
		ssd1681_vcom_t	vcom )

write vcom register

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	vcom	set vcom

Returns

status code

0 success
1 set vcom register failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1258 of file driver_ssd1681.c.

◆ ssd1681_set_vcom_sense_duration()

uint8_t ssd1681_set_vcom_sense_duration	(	ssd1681_handle_t *	handle,
		uint8_t	duration )

set the vcom sense duration

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	duration	vcom sense duration

Returns

status code

0 success
1 set vcom sense duration failed
2 handle is NULL
3 handle is not initialized

Note: vcom sense duration = (duration + 1) sec

Definition at line 1150 of file driver_ssd1681.c.

◆ ssd1681_software_reset()

uint8_t ssd1681_software_reset ( ssd1681_handle_t * handle )

software reset

Parameters

[in] *handle pointer to an ssd1681 handle structure

Returns

status code

0 success
1 software reset failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 625 of file driver_ssd1681.c.

◆ ssd1681_write_temperature_sensor()

uint8_t ssd1681_write_temperature_sensor	(	ssd1681_handle_t *	handle,
		uint16_t	control )

write the temperature sensor

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	control	set control

Returns

status code

0 success
1 write temperature sensor failed
2 handle is NULL
3 handle is not initialized
4 control is over 0xFFF

Note: none

Definition at line 789 of file driver_ssd1681.c.

◆ ssd1681_write_temperature_sensor_ext()

uint8_t ssd1681_write_temperature_sensor_ext	(	ssd1681_handle_t *	handle,
		uint8_t	param[3] )

write command to external temperature sensor

Parameters

[in]	*handle	pointer to an ssd1681 handle structure
[in]	*param	pointer to a param buffer

Returns

status code

0 success
1 write temperature sensor ext failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 870 of file driver_ssd1681.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ SSD1681_BUSY_MAX_DELAY_MS

◆ SSD1681_BUSY_MAX_RETRY_TIMES

Typedef Documentation

◆ ssd1681_handle_t

◆ ssd1681_info_t

Enumeration Type Documentation

◆ ssd1681_address_direction_t

◆ ssd1681_address_mode_t

◆ ssd1681_bool_t

◆ ssd1681_color_t

◆ ssd1681_display_control_t

◆ ssd1681_display_sequence_t

◆ ssd1681_driving_strength_t

◆ ssd1681_end_opt_t

◆ ssd1681_font_t

◆ ssd1681_gate_driving_voltage_t

◆ ssd1681_gs_transition_t

◆ ssd1681_min_off_time_t

◆ ssd1681_mode_t

◆ ssd1681_otp_mode_t

◆ ssd1681_phase_duration_t

◆ ssd1681_read_ram_t

◆ ssd1681_step_height_t

◆ ssd1681_step_width_t

◆ ssd1681_temperature_sensor_t

◆ ssd1681_vbd_fix_level_t

◆ ssd1681_vbd_t

◆ ssd1681_vbd_transition_t

◆ ssd1681_vci_level_t

◆ ssd1681_vcom_t

◆ ssd1681_vsh_t

◆ ssd1681_vsl_t

Function Documentation

◆ ssd1681_clear()

◆ ssd1681_deinit()

◆ ssd1681_get_crc_status()

◆ ssd1681_get_ram()

◆ ssd1681_get_status()

◆ ssd1681_get_user_id()

◆ ssd1681_gram_clear()

◆ ssd1681_gram_draw_picture()

◆ ssd1681_gram_fill_rect()

◆ ssd1681_gram_read_point()

◆ ssd1681_gram_update()

◆ ssd1681_gram_write_point()

◆ ssd1681_gram_write_string()

◆ ssd1681_info()

◆ ssd1681_init()

◆ ssd1681_nop()

◆ ssd1681_otp_initial()

◆ ssd1681_otp_initial_read()

◆ ssd1681_otp_initial_write()

◆ ssd1681_otp_load_waveform()

◆ ssd1681_otp_program_mode()

◆ ssd1681_otp_program_selection()

◆ ssd1681_otp_program_vcom()

◆ ssd1681_otp_program_waveform()

◆ ssd1681_otp_read_register()

◆ ssd1681_otp_write_register()

◆ ssd1681_read_temperature_sensor()

◆ ssd1681_set_auto_write_black_ram()

◆ ssd1681_set_auto_write_red_ram()

◆ ssd1681_set_black_ram()

◆ ssd1681_set_booster_soft_start()

◆ ssd1681_set_border_waveform()

◆ ssd1681_set_crc_calculation()

◆ ssd1681_set_data_entry_mode()

◆ ssd1681_set_display_sequence()

◆ ssd1681_set_display_update_control()

◆ ssd1681_set_driver_output()

◆ ssd1681_set_end_option()

◆ ssd1681_set_enter_vcom_sense()

◆ ssd1681_set_gate_driving_voltage()