Updated zh_ds18b20

This commit is contained in:
2024-05-31 18:31:26 +03:00
parent fe1cabef6d
commit a8cd9202c5
4 changed files with 14 additions and 11 deletions

View File

@ -17,18 +17,18 @@ extern "C"
#endif
/**
* @brief Read temperature from a specific 1-Wire device on bus.
* @brief Read temperature from a specific 1-Wire device on bus.
*
* @param[in] device Pointer to a buffer containing an eight-byte rom value. Can be NULL if only one 1-Wire device is present on the bus.
* @param[in] device Pointer to a buffer containing an eight-byte rom value. Can be NULL if only one 1-Wire device is present on the bus.
*
* @param[out] temperature Pointer to a buffer containing the received temperature.
* @param[out] temperature Pointer to a buffer containing the received temperature.
*
* @attention 1-Wire bus must be initialized first. @code zh_onewire_init(GPIO_NUM_X) @endcode
* @attention 1-Wire bus must be initialized first. @code zh_onewire_init(GPIO_NUM_X) @endcode
*
* @return
* - ESP_OK if read was successful
* - ESP_FAIL if any error
* - ESP_ERR_INVALID_CRC if case an read error
* - ESP_ERR_INVALID_CRC if check CRC is fail
*/
esp_err_t zh_ds18b20_read(const uint8_t *device, float *temperature);