SparkFun_HM01B0_Camera_Ar...

Skip to content Dismiss alert {{ message }} sparkfun / SparkFun_HM01B0_Camera_ArduinoLibrary Public

• Notifications You must be signed in to change notification settings
• Fork 6
• Star 16

• Code
• Issues 9
• Pull requests
• Actions
• Projects
• Security
• Insights

Additional navigation options

FilesExpand file tree

 master

Breadcrumbs

1. SparkFun_HM01B0_Camera_ArduinoLibrary
2. /src

/hm01b0.hCopy pathBlameMore file actionsBlameMore file actions

Latest commit

 

History

HistoryHistory488 lines (435 loc) · 17.8 KB master

Breadcrumbs

1. SparkFun_HM01B0_Camera_ArduinoLibrary
2. /src

/hm01b0.hTop

File metadata and controls

• Code
• Blame

488 lines (435 loc) · 17.8 KBRawCopy raw fileDownload raw fileOpen symbols panelEdit and raw actions123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488//*****************************************************************************////! @file HM01B0_C.h////*****************************************************************************#ifndef HM01B0_C_H#define HM01B0_C_H #include "stdint.h"#include "stdbool.h"#include "stdlib.h" #ifdef __cplusplusextern "C"{#endif #define HM01B0_DRV_VERSION (0)#define HM01B0_DRV_SUBVERSION (5) #define HM01B0_DEFAULT_ADDRESS (0x24) #define HM01B0_PIXEL_X_NUM (324)#define HM01B0_PIXEL_Y_NUM (244) #define HM01B0_REG_MODEL_ID_H (0x0000)#define HM01B0_REG_MODEL_ID_L (0x0001)#define HM01B0_REG_SILICON_REV (0x0002)#define HM01B0_REG_FRAME_COUNT (0x0005)#define HM01B0_REG_PIXEL_ORDER (0x0006) #define HM01B0_REG_MODE_SELECT (0x0100)#define HM01B0_REG_IMAGE_ORIENTATION (0x0101)#define HM01B0_REG_SW_RESET (0x0103)#define HM01B0_REG_GRP_PARAM_HOLD (0x0104) #define HM01B0_REG_INTEGRATION_H (0x0202)#define HM01B0_REG_INTEGRATION_L (0x0203)#define HM01B0_REG_ANALOG_GAIN (0x0205)#define HM01B0_REG_DIGITAL_GAIN_H (0x020E)#define HM01B0_REG_DIGITAL_GAIN_L (0x020F) #define HM01B0_REG_AE_TARGET_MEAN (0x2101)#define HM01B0_REG_AE_MIN_MEAN (0x2102)#define HM01B0_REG_CONVERGE_IN_TH (0x2103)#define HM01B0_REG_CONVERGE_OUT_TH (0x2104) #define HM01B0_REG_I2C_ID_SEL (0x3400)#define HM01B0_REG_I2C_ID_REG (0x3401) #define HM01B0_REG_PMU_PROGRAMMABLE_FRAMECNT (0x3020) // #define HM01B0_REG_MODE_SELECT (0x0100)#define HM01B0_REG_MODE_SELECT_STANDBY (0x00)#define HM01B0_REG_MODE_SELECT_STREAMING (0x01)#define HM01B0_REG_MODE_SELECT_STREAMING_NFRAMES (0x03)#define HM01B0_REG_MODE_SELECT_STREAMING_HW_TRIGGER (0x05) // #define HM01B0_REG_IMAGE_ORIENTATION (0x0101)#define HM01B0_REG_IMAGE_ORIENTATION_DEFAULT (0x00)#define HM01B0_REG_IMAGE_ORIENTATION_HMIRROR (0x01)#define HM01B0_REG_IMAGE_ORIENTATION_VMIRROR (0x02)#define HM01B0_REG_IMAGE_ORIENTATION_HVMIRROR (HM01B0_REG_IMAGE_ORIENTATION_HMIRROR | HM01B0_REG_IMAGE_ORIENTATION_HVMIRROR) // #define HM01B0_REG_GRP_PARAM_HOLD (0x0104)#define HM01B0_REG_GRP_PARAM_HOLD_CONSUME (0x00)#define HM01B0_REG_GRP_PARAM_HOLD_HOLD (0x01) #define HM01B0_MODEL_ID (0x01B0) // forward declarationstypedef struct _hm01b0_cfg_t hm01b0_cfg_t; typedef enum { HM01B0_ERR_OK = 0x00, HM01B0_ERR, HM01B0_ERR_I2C, HM01B0_ERR_MODE, HM01B0_ERR_AE_NOT_CONVERGED, HM01B0_ERR_MCLK, HM01B0_ERR_INIT, HM01B0_ERR_DEINIT, HM01B0_ERR_PARAMS, HM01B0_ERR_UNIMPLEMENTED, HM01B0_NUM_ERR} hm01b0_status_e; typedef hm01b0_status_e (*hm01b0_if_fn_t)(hm01b0_cfg_t* psCfg, void* arg);typedef hm01b0_status_e (*hm01b0_if_i2c_fn_t)(hm01b0_cfg_t* psCfg, uint16_t ui16Reg, uint8_t *pui8Value, uint32_t ui32NumBytes, void* arg);typedef hm01b0_status_e (*hm01b0_if_on_off_fn_t)(hm01b0_cfg_t* psCfg, bool enable, void* arg);typedef struct { hm01b0_if_fn_t init; // any initialization code needed hm01b0_if_i2c_fn_t write; // write to registers over I2C hm01b0_if_i2c_fn_t read; // read from registers over I2C hm01b0_if_on_off_fn_t mclk; // enable/disable the clock generation hardware hm01b0_if_on_off_fn_t trig; // enable/disabe the trigger pin hm01b0_if_fn_t deinit; // any deinitialization code needed void* arg; // argument for the user available in interface functions} hm01b0_if_t; // abstracts the interface for the HM01B0 typedef struct{ uint16_t ui16Reg; uint8_t ui8Val;} hm_script_t; struct _hm01b0_cfg_t { hm01b0_if_t* interface;}; typedef struct{ uint8_t ui8AETargetMean; uint8_t ui8AEMinMean; uint8_t ui8ConvergeInTh; uint8_t ui8ConvergeOutTh; uint8_t ui8AEMean;} hm01b0_ae_cfg_t; typedef struct{ uint8_t ui8IntegrationH; uint8_t ui8IntegrationL; uint8_t ui8AGain; uint8_t ui8DGain_H; uint8_t ui8DGain_L;} hm01b0_snr_expo_gain_ctrl_t; //*****************************************************************************////! @brief Write HM01B0 registers//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param ui16Reg - Register address.//! @param pui8Value - Pointer to the data to be written.//! @param ui32NumBytes - Length of the data in bytes to be written.//!//! This function writes value to HM01B0 registers.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_write_reg(hm01b0_cfg_t *psCfg, uint16_t ui16Reg, uint8_t *pui8Value, uint32_t ui32NumBytes); //*****************************************************************************////! @brief Read HM01B0 registers//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param ui16Reg - Register address.//! @param pui8Value - Pointer to the buffer for read data to be put into.//! @param ui32NumBytes - Length of the data to be read.//!//! This function reads value from HM01B0 registers.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_read_reg(hm01b0_cfg_t *psCfg, uint16_t ui16Reg, uint8_t *pui8Value, uint32_t ui32NumBytes); //*****************************************************************************////! @brief Load HM01B0 a given script//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param psScrip - Pointer to the script to be loaded.//! @param ui32ScriptCmdNum - Number of entries in a given script.//!//! This function loads HM01B0 a given script.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_load_script(hm01b0_cfg_t *psCfg, hm_script_t *psScript, uint32_t ui32ScriptCmdNum); //*****************************************************************************////! @brief Power up HM01B0//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function powers up HM01B0.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_power_up(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Power down HM01B0//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function powers up HM01B0.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_power_down(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Enable MCLK//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function utilizes CTimer to generate MCLK for HM01B0.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_mclk_enable(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Disable MCLK//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function disable CTimer to stop MCLK for HM01B0.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_mclk_disable(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Initialize interfaces//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function initializes interfaces.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_init_if(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Deinitialize interfaces//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function deinitializes interfaces.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_deinit_if(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Get HM01B0 Model ID//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param pui16MID - Pointer to buffer for the read back model ID.//!//! This function reads back HM01B0 model ID.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_get_modelid(hm01b0_cfg_t *psCfg, uint16_t *pui16MID); //*****************************************************************************////! @brief Initialize HM01B0//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param psScript - Pointer to HM01B0 initialization script.//! @param ui32ScriptCmdNum - No. of commands in HM01B0 initialization script.//!//! This function initilizes HM01B0 with a given script.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_init_system(hm01b0_cfg_t *psCfg, hm_script_t *psScript, uint32_t ui32ScriptCmdNum); //*****************************************************************************////! @brief Set HM01B0 in the walking 1s test mode//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function sets HM01B0 in the walking 1s test mode.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_test_walking1s(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Check the data read from HM01B0 in the walking 1s test mode//!//! @param pui8Buffer - Pointer to data buffer.//! @param ui32BufferLen - Buffer length//!//! This function sets HM01B0 in the walking 1s test mode.//!//! @return Mismatch count.////*****************************************************************************uint32_t hm01b0_test_walking1s_check_data_sanity(uint8_t *pui8Buffer, uint32_t ui32BufferLen); //*****************************************************************************////! @brief Software reset HM01B0//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! This function resets HM01B0 by issuing a reset command.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_reset_sw(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Get current HM01B0 operation mode.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param pui8Mode - Pointer to buffer//! - for the read back operation mode to be put into//!//! This function get HM01B0 operation mode.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_get_mode(hm01b0_cfg_t *psCfg, uint8_t *pui8Mode); //*****************************************************************************////! @brief Set HM01B0 operation mode.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param ui8Mode - Operation mode. One of://! HM01B0_REG_MODE_SELECT_STANDBY//! HM01B0_REG_MODE_SELECT_STREAMING//! HM01B0_REG_MODE_SELECT_STREAMING_NFRAMES//! HM01B0_REG_MODE_SELECT_STREAMING_HW_TRIGGER//! @param framecnt - Frame count for HM01B0_REG_MODE_SELECT_STREAMING_NFRAMES.//! - Discarded if other modes.//!//! This function set HM01B0 operation mode.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_set_mode(hm01b0_cfg_t *psCfg, uint8_t ui8Mode, uint8_t framecnt); //*****************************************************************************////! @brief Activate the updated settings to HM01B0.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//!//! Some settings updated to HM01B0 will only be affected after calling this function//! 1. AE settings//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_cmd_update(hm01b0_cfg_t *psCfg); //*****************************************************************************////! @brief Get HM01B0 AE settings//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param psAECfg - Pointer to the structure hm01b0_ae_cfg_t.//!//! This function checks if AE is converged or not and returns ui32Err accordingly.//! If caller needs detailed AE settings, psAECfg has to be non NULL.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_get_ae(hm01b0_cfg_t *psCfg, hm01b0_ae_cfg_t *psAECfg); //*****************************************************************************////! @brief AE calibration.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param ui8CalFrames - Frame counts for calibratoin.//! @param pui8Buffer - Pointer to the frame buffer.//! @param ui32BufferLen - Framebuffer size.//! @param pAECfg - Pointer to hm01b0_ae_cfg_t structure to fill with calibration results//!//! This function lets HM01B0 AE settled as much as possible within a given frame counts.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_cal_ae(hm01b0_cfg_t *psCfg, uint8_t ui8CalFrames, uint8_t *pui8Buffer, uint32_t ui32BufferLen, hm01b0_ae_cfg_t* pAECfg ); //*****************************************************************************////! @brief Save HM01B0 exposure gain settings.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param psExpoGainCtrl - Pointer to the structure hm01b0_snr_expo_gain_ctrl_t//!//! This function saves HM01B0 exposure gain settings.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_save_exposure_gains(hm01b0_cfg_t *psCfg, hm01b0_snr_expo_gain_ctrl_t *psExpoGainCtrl); //*****************************************************************************////! @brief Restore HM01B0 exposure gain settings.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param psExpoGainCtrl - Pointer to the structure hm01b0_snr_expo_gain_ctrl_t//!//! This function restores HM01B0 exposure gain settings. The call flow shall be//! hm01b0_restore_exposure_gains() -> hm01b0_cmd_update() -> hm01b0_set_mode()//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_restore_exposure_gains(hm01b0_cfg_t *psCfg, hm01b0_snr_expo_gain_ctrl_t *psExpoGainCtrl); //*****************************************************************************////! @brief Hardware trigger HM01B0 to stream.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param bTrigger - True to start streaming//! - False to stop streaming//!//! This function triggers HM01B0 to stream by toggling the TRIG pin.//!//! @return Error code.////*****************************************************************************hm01b0_status_e HM01B0_C_Hardware_trigger_streaming(hm01b0_cfg_t *psCfg, bool bTrigger); //*****************************************************************************////! @brief Set HM01B0 mirror mode.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param bHmirror - Horizontal mirror//! @param bVmirror - Vertical mirror//!//! This function set HM01B0 mirror mode.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_set_mirror(hm01b0_cfg_t *psCfg, bool bHmirror, bool bVmirror); //*****************************************************************************////! @brief Read data of one frame from HM01B0.//!//! @param psCfg - Pointer to HM01B0 configuration structure.//! @param pui8Buffer - Pointer to the frame buffer.//! @param ui32BufferLen - Framebuffer size.//!//! This function read data of one frame from HM01B0.//!//! @return Error code.////*****************************************************************************hm01b0_status_e hm01b0_blocking_read_oneframe(hm01b0_cfg_t *psCfg, \ uint8_t *pui8Buffer, uint32_t ui32BufferLen); #ifdef __cplusplus}#endif #endif // AM_HAL_CTIMER_H You can’t perform that action at this time.