feat: initial

README.md

@@ -1,7 +1,34 @@
-# zh_avr_i2c
+# FreeRTOS based AVR library for I2C bus
 
-AVR library for I2C bus.
+## Features
 
+1. Simple read and write data.
+
+## Dependencies
+
+1. [zh_avr_free_rtos](http://git.zh.com.ru/avr_libraries/zh_avr_free_rtos)
+
+## Using
+
+In an existing project, run the following command to install the component:
+
+```text
+cd ../your_project/lib
+git clone http://git.zh.com.ru/avr_libraries/zh_avr_free_rtos
+git clone http://git.zh.com.ru/avr_libraries/zh_avr_i2c
+```
+
+In the application, add the component:
+
+```c
+#include "zh_avr_i2c.h"
+```
+
+## Example
+
+Master read and write data:
+
+```c
 #include "avr/io.h"
 #include "stdio.h"
 #include "zh_avr_i2c.h"
@@ -65,3 +92,4 @@ int main(void)
     vTaskStartScheduler();
     return 0;
 }
+```

include/zh_avr_i2c.h

@@ -39,15 +39,37 @@ extern "C"
 	avr_err_t zh_avr_i2c_master_init(const bool pullup);
 
 	/**
-	 * @brief Probe I2C address, if address is correct and ACK is received, this function will return AVR_OK.
+	 * @brief Probe I2C address.
 	 *
-	 * @param[in] addr Address I2C device address that you want to probe.
+	 * @param[in] addr Address I2C device.
 	 * @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
 	 *
 	 * @return AVR_OK if success or an error code otherwise.
 	 */
 	avr_err_t zh_avr_i2c_master_probe(const uint8_t addr, TickType_t xTicksToWait);
+
+	/**
+	 * @brief Send data to I2C address.
+	 *
+	 * @param[in] addr Address I2C device.
+	 * @param[in] data Pointer to data for send.
+	 * @param[in] size Data size.
+	 * @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
+	 *
+	 * @return AVR_OK if success or an error code otherwise.
+	 */
 	avr_err_t zh_avr_i2c_master_transmit(const uint8_t addr, uint8_t *data, uint8_t size, TickType_t xTicksToWait);
+
+	/**
+	 * @brief Read data from I2C address.
+	 *
+	 * @param[in] addr Address I2C device.
+	 * @param[out] data Pointer to buffer for read.
+	 * @param[in] size Data size.
+	 * @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
+	 *
+	 * @return AVR_OK if success or an error code otherwise.
+	 */
 	avr_err_t zh_avr_i2c_master_receive(const uint8_t addr, uint8_t *data, uint8_t size, TickType_t xTicksToWait);
 
 	avr_err_t zh_avr_i2c_master_transmit_register(const uint8_t addr, uint16_t *reg, uint8_t *data, uint8_t size, TickType_t xTicksToWait); // To Do