feat: initial
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1 +1 @@
|
|||||||
.DS_Store
|
.DS_Store
|
Binary file not shown.
Binary file not shown.
122
README.md
122
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 "avr/io.h"
|
||||||
#include "stdio.h"
|
#include "stdio.h"
|
||||||
#include "zh_avr_i2c.h"
|
#include "zh_avr_i2c.h"
|
||||||
@@ -11,57 +38,58 @@ AVR library for I2C bus.
|
|||||||
|
|
||||||
int usart(char byte, FILE *stream)
|
int usart(char byte, FILE *stream)
|
||||||
{
|
{
|
||||||
while ((UCSR0A & (1 << UDRE0)) == 0)
|
while ((UCSR0A & (1 << UDRE0)) == 0)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
UDR0 = byte;
|
UDR0 = byte;
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
FILE uart = FDEV_SETUP_STREAM(usart, NULL, _FDEV_SETUP_WRITE);
|
FILE uart = FDEV_SETUP_STREAM(usart, NULL, _FDEV_SETUP_WRITE);
|
||||||
|
|
||||||
void i2c_example_task(void *pvParameters)
|
void i2c_example_task(void *pvParameters)
|
||||||
{
|
{
|
||||||
zh_avr_i2c_master_init(false);
|
zh_avr_i2c_master_init(false);
|
||||||
for (;;)
|
for (;;)
|
||||||
{
|
{
|
||||||
avr_err_t err = zh_avr_i2c_master_probe(0x38, 100 / portTICK_PERIOD_MS);
|
avr_err_t err = zh_avr_i2c_master_probe(0x38, 100 / portTICK_PERIOD_MS);
|
||||||
if (err == AVR_OK)
|
if (err == AVR_OK)
|
||||||
{
|
{
|
||||||
uint8_t data_send = 111;
|
uint8_t data_send = 111;
|
||||||
uint8_t data_read = 0;
|
uint8_t data_read = 0;
|
||||||
printf("Data Send %d.\n", data_send);
|
printf("Data Send %d.\n", data_send);
|
||||||
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
|
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
|
||||||
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
|
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
|
||||||
printf("Data Read %d.\n", data_read);
|
printf("Data Read %d.\n", data_read);
|
||||||
data_send = 55;
|
data_send = 55;
|
||||||
printf("Data Send %d.\n", data_send);
|
printf("Data Send %d.\n", data_send);
|
||||||
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
|
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
|
||||||
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
|
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
|
||||||
printf("Data Read %d.\n", data_read);
|
printf("Data Read %d.\n", data_read);
|
||||||
data_send = 14;
|
data_send = 14;
|
||||||
printf("Data Send %d.\n", data_send);
|
printf("Data Send %d.\n", data_send);
|
||||||
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
|
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
|
||||||
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
|
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
|
||||||
printf("Data Read %d.\n", data_read);
|
printf("Data Read %d.\n", data_read);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
printf("Device Not Found.\n");
|
printf("Device Not Found.\n");
|
||||||
}
|
}
|
||||||
printf("Task Remaining Stack Size %d.\n", uxTaskGetStackHighWaterMark(NULL));
|
printf("Task Remaining Stack Size %d.\n", uxTaskGetStackHighWaterMark(NULL));
|
||||||
vTaskDelay(5000 / portTICK_PERIOD_MS);
|
vTaskDelay(5000 / portTICK_PERIOD_MS);
|
||||||
}
|
}
|
||||||
vTaskDelete(NULL);
|
vTaskDelete(NULL);
|
||||||
}
|
}
|
||||||
|
|
||||||
int main(void)
|
int main(void)
|
||||||
{
|
{
|
||||||
UBRR0H = (BAUD_PRESCALE >> 8);
|
UBRR0H = (BAUD_PRESCALE >> 8);
|
||||||
UBRR0L = BAUD_PRESCALE;
|
UBRR0L = BAUD_PRESCALE;
|
||||||
UCSR0B = (1 << RXEN0) | (1 << TXEN0);
|
UCSR0B = (1 << RXEN0) | (1 << TXEN0);
|
||||||
UCSR0C = (1 << UCSZ01) | (1 << UCSZ00);
|
UCSR0C = (1 << UCSZ01) | (1 << UCSZ00);
|
||||||
stdout = &uart;
|
stdout = &uart;
|
||||||
xTaskCreate(i2c_example_task, "i2c example task", 110, NULL, tskIDLE_PRIORITY, NULL);
|
xTaskCreate(i2c_example_task, "i2c example task", 110, NULL, tskIDLE_PRIORITY, NULL);
|
||||||
vTaskStartScheduler();
|
vTaskStartScheduler();
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
@@ -39,15 +39,37 @@ extern "C"
|
|||||||
avr_err_t zh_avr_i2c_master_init(const bool pullup);
|
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.
|
* @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
|
||||||
*
|
*
|
||||||
* @return AVR_OK if success or an error code otherwise.
|
* @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);
|
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);
|
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_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
|
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
|
||||||
|
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user