Reference
Last revision 2026/01/14
This guide offers a detailed reference for the DFRobot_OSD API, highlighting key functions and compatibility with Arduino MCUs like FireBeetle-Board328P, ESP32, and Leonardo.
API Description
/**
* @fn DFRobot_OSD
* @brief Constructor
* @param CS - CS selection pin
* @return None
*/
DFRobot_OSD(int CS);
DFRobot_OSD();
/**
* @fn init
* @brief Init function
* @return None
*/
void init();
/**
* @fn displayChar
* @brief display char
* @param row - Horizontal coordinate, range(0,15)
* @param col - Vertical coordinate, range(0,29)
* @param value - addr of char in eeprom
* @return None
*/
void displayChar(unsigned char row, unsigned char col, unsigned short addr);
/**
* @fn displayChar
* @brief display string
* @param row - Horizontal coordinate, range(0,15)
* @param col - Vertical coordinate, range(0,29)
* @param s - String
* @return None
*/
void displayString(unsigned char row, unsigned char col, const char *s);
void displayString(unsigned char row, unsigned char col, String s);
/**
* @fn clear
* @brief Clear screen
* @return None
*/
void clear(void);
/**
* @fn storeChar
* @brief Write the custom character to the OSD, replacing the original character
* @param addr - Address of the stored character
* @param dt - Array generated through the tool
* @return None
*/
void storeChar(unsigned short addr,int dt[]);
Compatibility Information
| MCU | Pass | Failed | Not Tested | Remark |
|---|---|---|---|---|
| FireBeetle-Board328P | √ | |||
| FireBeetle-ESP32 | √ | |||
| FireBeetle-ESP8266 | √ | |||
| Leonardo | √ | Tested with Dupont wire |
Was this article helpful?
