** * writeEEPROM * Write EEPROM through I2C bus * addr EEPROM data address 8bits * pBuf Storage and buffer for data to be written * size Length of data to be written * The data size that users can freely store is 247 bytes, range 0-247 * The last 8 bytes are for storing the time data saved when the user call saveTimeToEEPROM() * None */ void writeEEPROM( uint8_t addr, const uint8_t* pBuf, size_t size) ** * readEEPROM * Read EEPROM through I2C bus * addr EEPROM data address 8bits * pBuf Storage and buffer for data to be read * size Length of the data to be read * Return the read length, returning 0 indicates reading failed */ size_t readEEPROM( uint8_t addr, uint8_t* pBuf, size_t size) * If the MCU board is reset when sensor is not powered off, the interface may be miscalled and the time may be changed by mistake. ** * setTimeFromEEPROM * Set the time to when last saved * If saveTimeToEEPROM() wasn’t called before or the contents in EEPROM have been modified after the call, * the time setting error may occur. ** * saveTimeToEEPROM * Store the current time into EEPROM, which can be used to set the time to the last saved one after power off * Call the interface when powering off and call setTimeFromEEPROM() to realize when restarting * None */ void saveTimeToEEPROM( void)
** * getSqwPinMode * Get the current output mode of SQW/OUT pin * eSqwPinMode_t: * eSquareWave_LOW, eSquareWave_HIGH, eSquareWave_1Hz, * eSquareWave_4kHz, eSquareWave_8kHz, eSquareWave_32kHz */ ** * setSqwPinMode * Control the operation of the SQW/OUT pin * mode SQW Pin Output mode: * eSquareWave_LOW, eSquareWave_HIGH, eSquareWave_1Hz, * eSquareWave_4kHz, eSquareWave_8kHz, eSquareWave_32kHz * None */ void setSqwPinMode(eSqwPinMode_t mode) ** * stop * Stop RTC timing function * this bit is part of the seconds byte * None */ void stop( void) ** * start * Start RTC timing function * this bit is part of the seconds byte * None */ void start( void) ** * setTypeTime * According to the set time type, input the value in corresponding range, set time * type Time type to be obtained, eTimeType_t: * eSEC, eMIN, eHR, eDOW, eDATE, eMTH, eYR * typeTime According to the selected time type, write the value of the corresponding range * When setting eSEC type, range: 00-59 * When setting eMIN type, range: 00-59 * When setting eHR type, range: 00-23 * When setting eDOW type, range: 01-07 * When setting eDATE type, range: 01-31 * When setting eMTH type, range: 01-12 * When setting eYR type, range: 2000-2099 * Note: Values out of range will result in a setting error * None */ void setTypeTime(eTimeType_t type, uint16_t typeTime) ** * setTime * According to the available array, set all the time * rtc Array in the following format (type is uint16_t) * rtc for eSEC type, range: 00-59 * rtc for eMIN type, range: 00-59 * rtc for eHR type, range: 00-23 * rtc for eDOW type, range: 01-07 * rtc for eDATE type, range: 01-31 * rtc for eMTH type, range: 01-12 * rtc for eYR type, range: 2000-2099 * Note: Values out of range will result in a setting error * None */ void setTime( uint16_t *rtc) ** * getTypeTime * Get the time of one type from rtc module and convert it to uint16_t * type Time type to be obtained, eTimeType_t: * eSEC, eMIN, eHR, eDOW, eDATE, eMTH, eYR * According to the selected time type, return the value uint16_t of the corresponding range * When reading eSEC type, range: 00-59 * When reading eMIN type, range: 00-59 * When reading eHR type, range: 00-23 * When reading eDOW type, range: 01-07 * When reading eDATE type, range: 01-31 * When reading eMTH type, range: 01-12 * When reading eYR type, range: 2000-2099 */ uint16_t getTypeTime(eTimeType_t type) ** * getTime * Get the time from rtc module and convert it to uint16_t * rtc Array for buffering the obtained time * * None */ void getTime( uint16_t *rtc)
** * begin * Init function * true indicate init succeed false indicate init failed */ bool begin( void)
0 kommentar(er)
