add some code
This commit is contained in:
@@ -0,0 +1 @@
|
||||
8a9e3a7dbef589a54f814ff22e9121da86bce19d0e1ccffa53f5df6bb346a140
|
||||
@@ -0,0 +1 @@
|
||||
{"version": "1.0", "algorithm": "sha256", "created_at": "2025-05-21T16:03:33.544915+00:00", "files": [{"path": "CMakeLists.txt", "size": 98, "hash": "91da70b7c8ef8bc6f3a2f386935322aa84df46e317c4a559f19ec56966d1c4e7"}, {"path": "idf_component.yml", "size": 421, "hash": "335f77784f3ed11e50ac5ae1077afa98cd464127a5d98f320fc77c6f365a4530"}, {"path": "esp_io_expander_tca9554.c", "size": 5528, "hash": "39a9d6e14bcb146b49164ee3e5c8cafae821fdd443de07580f855b751c3e2ba2"}, {"path": "README.md", "size": 2242, "hash": "2472d2784440d606ad0c411de0e4d61400c4a7c1da5096d363685725517cacbb"}, {"path": "license.txt", "size": 11358, "hash": "cfc7749b96f63bd31c3c42b5c471bf756814053e847c10f3eb003417bc523d30"}, {"path": "include/esp_io_expander_tca9554.h", "size": 3889, "hash": "c3ec507c8c18415bdb8308a482b067b541b02c64c3780c0be6055d5c5354b399"}, {"path": "test_apps/CMakeLists.txt", "size": 260, "hash": "7bec141915f7f08bb3aa198c395df5f59e4a8af94f93527d420f122b532c0e33"}, {"path": "test_apps/sdkconfig.defaults", "size": 131, "hash": "bd754a0a0d72d0d9bce8a02e7eb10a1dbf7f01ec7ce4225135b2562e00242252"}, {"path": "test_apps/main/CMakeLists.txt", "size": 79, "hash": "9e6568462be45021953b9430c615ee6def74541021571d59af9c375799a9fa68"}, {"path": "test_apps/main/idf_component.yml", "size": 166, "hash": "7599af43fb5a6c8a322c99bc95ed49d7766689b7a606a74a4ce5e704ae5b7bca"}, {"path": "test_apps/main/test_app_tca9554.c", "size": 6020, "hash": "3b82f9a68f6529fa4a70d1d788969b845fe59ef8bd704a3111416ebbb868fff2"}]}
|
||||
@@ -0,0 +1 @@
|
||||
idf_component_register(SRCS "esp_io_expander_tca9554.c" INCLUDE_DIRS "include" REQUIRES "driver")
|
||||
@@ -0,0 +1,62 @@
|
||||
# ESP IO Expander Chip TCA9554(A)
|
||||
|
||||
[](https://components.espressif.com/components/espressif/esp_io_expander_tca9554)
|
||||
|
||||
Implementation of the TCA9554 io expander chip with esp_io_expander component.
|
||||
|
||||
| Chip | Communication interface | Component name | Link to datasheet |
|
||||
| :--------------: | :---------------------: | :------------: | :---------------: |
|
||||
| TCA9554(A) | I2C | esp_io_expander_tca9554 | [datasheet](https://www.ti.com/lit/gpn/tca9554) |
|
||||
|
||||
## Add to project
|
||||
|
||||
Packages from this repository are uploaded to [Espressif's component service](https://components.espressif.com/).
|
||||
You can add them to your project via `idf.py add-dependency`, e.g.
|
||||
```
|
||||
idf.py add-dependency esp_io_expander_tca9554==1.0.0
|
||||
```
|
||||
|
||||
Alternatively, you can create `idf_component.yml`. More is in [Espressif's documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html).
|
||||
|
||||
## Example use
|
||||
|
||||
Creation of the i2c bus.
|
||||
|
||||
```c
|
||||
i2c_master_bus_handle_t i2c_handle = NULL;
|
||||
const i2c_master_bus_config_t bus_config = {
|
||||
.i2c_port = I2C_NUM_0,
|
||||
.sda_io_num = 47,
|
||||
.scl_io_num = 48,
|
||||
.clk_source = I2C_CLK_SRC_DEFAULT,
|
||||
};
|
||||
i2c_new_master_bus(&bus_config, &i2c_handle);
|
||||
```
|
||||
|
||||
Creation of the component.
|
||||
|
||||
```c
|
||||
esp_io_expander_handle_t io_expander = NULL;
|
||||
esp_io_expander_new_i2c_tca9554(i2c_handle, ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_000, &io_expander);
|
||||
```
|
||||
|
||||
Print all pins's status to the log:
|
||||
|
||||
```c
|
||||
esp_io_expander_print_state(io_expander);
|
||||
```
|
||||
|
||||
Set pin 0 and pin 1 with output dircetion and low level:
|
||||
|
||||
```c
|
||||
esp_io_expander_set_dir(io_expander, IO_EXPANDER_PIN_NUM_0 | IO_EXPANDER_PIN_NUM_1, IO_EXPANDER_OUTPUT);
|
||||
esp_io_expander_set_level(io_expander, IO_EXPANDER_PIN_NUM_0 | IO_EXPANDER_PIN_NUM_1, 0);
|
||||
```
|
||||
|
||||
Set pin 2 and pin 3 with input dircetion:
|
||||
|
||||
```c
|
||||
uint32_t pin_levels = 0;
|
||||
esp_io_expander_set_dir(io_expander, IO_EXPANDER_PIN_NUM_2 | IO_EXPANDER_PIN_NUM_3, IO_EXPANDER_INPUT);
|
||||
esp_io_expander_get_level(io_expander, IO_EXPANDER_PIN_NUM_2 | IO_EXPANDER_PIN_NUM_3, &pin_levels);
|
||||
```
|
||||
@@ -0,0 +1,154 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <inttypes.h>
|
||||
#include <string.h>
|
||||
#include <stdlib.h>
|
||||
#include "esp_bit_defs.h"
|
||||
#include "esp_check.h"
|
||||
#include "esp_log.h"
|
||||
#include "esp_io_expander.h"
|
||||
#include "esp_io_expander_tca9554.h"
|
||||
|
||||
/* I2C communication related */
|
||||
#define I2C_TIMEOUT_MS (1000)
|
||||
#define I2C_CLK_SPEED (400000)
|
||||
|
||||
#define IO_COUNT (8)
|
||||
|
||||
/* Register address */
|
||||
#define INPUT_REG_ADDR (0x00)
|
||||
#define OUTPUT_REG_ADDR (0x01)
|
||||
#define DIRECTION_REG_ADDR (0x03)
|
||||
|
||||
/* Default register value on power-up */
|
||||
#define DIR_REG_DEFAULT_VAL (0xff)
|
||||
#define OUT_REG_DEFAULT_VAL (0xff)
|
||||
|
||||
/**
|
||||
* @brief Device Structure Type
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
esp_io_expander_t base;
|
||||
i2c_master_dev_handle_t i2c_handle;
|
||||
struct {
|
||||
uint8_t direction;
|
||||
uint8_t output;
|
||||
} regs;
|
||||
} esp_io_expander_tca9554_t;
|
||||
|
||||
static char *TAG = "tca9554";
|
||||
|
||||
static esp_err_t read_input_reg(esp_io_expander_handle_t handle, uint32_t *value);
|
||||
static esp_err_t write_output_reg(esp_io_expander_handle_t handle, uint32_t value);
|
||||
static esp_err_t read_output_reg(esp_io_expander_handle_t handle, uint32_t *value);
|
||||
static esp_err_t write_direction_reg(esp_io_expander_handle_t handle, uint32_t value);
|
||||
static esp_err_t read_direction_reg(esp_io_expander_handle_t handle, uint32_t *value);
|
||||
static esp_err_t reset(esp_io_expander_t *handle);
|
||||
static esp_err_t del(esp_io_expander_t *handle);
|
||||
|
||||
esp_err_t esp_io_expander_new_i2c_tca9554(i2c_master_bus_handle_t i2c_bus, uint32_t dev_addr, esp_io_expander_handle_t *handle_ret)
|
||||
{
|
||||
ESP_RETURN_ON_FALSE(handle_ret != NULL, ESP_ERR_INVALID_ARG, TAG, "Invalid handle_ret");
|
||||
|
||||
// Allocate memory for driver object
|
||||
esp_io_expander_tca9554_t *tca9554 = (esp_io_expander_tca9554_t *)calloc(1, sizeof(esp_io_expander_tca9554_t));
|
||||
ESP_RETURN_ON_FALSE(tca9554 != NULL, ESP_ERR_NO_MEM, TAG, "Malloc failed");
|
||||
|
||||
// Add new I2C device
|
||||
esp_err_t ret = ESP_OK;
|
||||
const i2c_device_config_t i2c_dev_cfg = {
|
||||
.device_address = dev_addr,
|
||||
.scl_speed_hz = I2C_CLK_SPEED,
|
||||
};
|
||||
ESP_GOTO_ON_ERROR(i2c_master_bus_add_device(i2c_bus, &i2c_dev_cfg, &tca9554->i2c_handle), err, TAG, "Add new I2C device failed");
|
||||
|
||||
tca9554->base.config.io_count = IO_COUNT;
|
||||
tca9554->base.config.flags.dir_out_bit_zero = 1;
|
||||
tca9554->base.read_input_reg = read_input_reg;
|
||||
tca9554->base.write_output_reg = write_output_reg;
|
||||
tca9554->base.read_output_reg = read_output_reg;
|
||||
tca9554->base.write_direction_reg = write_direction_reg;
|
||||
tca9554->base.read_direction_reg = read_direction_reg;
|
||||
tca9554->base.del = del;
|
||||
tca9554->base.reset = reset;
|
||||
|
||||
/* Reset configuration and register status */
|
||||
ESP_GOTO_ON_ERROR(reset(&tca9554->base), err, TAG, "Reset failed");
|
||||
|
||||
*handle_ret = &tca9554->base;
|
||||
return ESP_OK;
|
||||
err:
|
||||
free(tca9554);
|
||||
return ret;
|
||||
}
|
||||
|
||||
static esp_err_t read_input_reg(esp_io_expander_handle_t handle, uint32_t *value)
|
||||
{
|
||||
esp_io_expander_tca9554_t *tca9554 = (esp_io_expander_tca9554_t *)__containerof(handle, esp_io_expander_tca9554_t, base);
|
||||
|
||||
uint8_t temp = 0;
|
||||
ESP_RETURN_ON_ERROR(i2c_master_transmit_receive(tca9554->i2c_handle, (uint8_t[]) {
|
||||
INPUT_REG_ADDR
|
||||
}, 1, &temp, sizeof(temp), I2C_TIMEOUT_MS), TAG, "Read input reg failed");
|
||||
*value = temp;
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t write_output_reg(esp_io_expander_handle_t handle, uint32_t value)
|
||||
{
|
||||
esp_io_expander_tca9554_t *tca9554 = (esp_io_expander_tca9554_t *)__containerof(handle, esp_io_expander_tca9554_t, base);
|
||||
value &= 0xff;
|
||||
|
||||
uint8_t data[] = {OUTPUT_REG_ADDR, value};
|
||||
ESP_RETURN_ON_ERROR(i2c_master_transmit(tca9554->i2c_handle, data, sizeof(data), I2C_TIMEOUT_MS), TAG, "Write output reg failed");
|
||||
tca9554->regs.output = value;
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t read_output_reg(esp_io_expander_handle_t handle, uint32_t *value)
|
||||
{
|
||||
esp_io_expander_tca9554_t *tca9554 = (esp_io_expander_tca9554_t *)__containerof(handle, esp_io_expander_tca9554_t, base);
|
||||
|
||||
*value = tca9554->regs.output;
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t write_direction_reg(esp_io_expander_handle_t handle, uint32_t value)
|
||||
{
|
||||
esp_io_expander_tca9554_t *tca9554 = (esp_io_expander_tca9554_t *)__containerof(handle, esp_io_expander_tca9554_t, base);
|
||||
value &= 0xff;
|
||||
|
||||
uint8_t data[] = {DIRECTION_REG_ADDR, value};
|
||||
ESP_RETURN_ON_ERROR(i2c_master_transmit(tca9554->i2c_handle, data, sizeof(data), I2C_TIMEOUT_MS), TAG, "Write direction reg failed");
|
||||
tca9554->regs.direction = value;
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t read_direction_reg(esp_io_expander_handle_t handle, uint32_t *value)
|
||||
{
|
||||
esp_io_expander_tca9554_t *tca9554 = (esp_io_expander_tca9554_t *)__containerof(handle, esp_io_expander_tca9554_t, base);
|
||||
|
||||
*value = tca9554->regs.direction;
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t reset(esp_io_expander_t *handle)
|
||||
{
|
||||
ESP_RETURN_ON_ERROR(write_direction_reg(handle, DIR_REG_DEFAULT_VAL), TAG, "Write dir reg failed");
|
||||
ESP_RETURN_ON_ERROR(write_output_reg(handle, OUT_REG_DEFAULT_VAL), TAG, "Write output reg failed");
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t del(esp_io_expander_t *handle)
|
||||
{
|
||||
esp_io_expander_tca9554_t *tca9554 = (esp_io_expander_tca9554_t *)__containerof(handle, esp_io_expander_tca9554_t, base);
|
||||
|
||||
ESP_RETURN_ON_ERROR(i2c_master_bus_rm_device(tca9554->i2c_handle), TAG, "Remove I2C device failed");
|
||||
free(tca9554);
|
||||
return ESP_OK;
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
dependencies:
|
||||
esp_io_expander:
|
||||
public: true
|
||||
version: ^1.0.1
|
||||
idf: '>=5.2'
|
||||
description: ESP IO Expander - TCA9554(A)
|
||||
repository: git://github.com/espressif/esp-bsp.git
|
||||
repository_info:
|
||||
commit_sha: d08dd309525a6f184a1b83dd9403c655b5e8339e
|
||||
path: components/io_expander/esp_io_expander_tca9554
|
||||
url: https://github.com/espressif/esp-bsp/tree/master/components/io_expander/esp_io_expander_tca9554
|
||||
version: 2.0.0
|
||||
@@ -0,0 +1,90 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @brief ESP IO expander: TCA9554
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
#include "esp_err.h"
|
||||
#include "driver/i2c_master.h"
|
||||
#include "esp_io_expander.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Create a TCA9554(A) IO expander object
|
||||
*
|
||||
* @param[in] i2c_bus I2C bus handle. Obtained from `i2c_new_master_bus()`
|
||||
* @param[in] dev_addr I2C device address of chip. Can be `ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_XXX` or `ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_XXX`.
|
||||
* @param[out] handle_ret Handle to created IO expander object
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK: Success, otherwise returns ESP_ERR_xxx
|
||||
*/
|
||||
esp_err_t esp_io_expander_new_i2c_tca9554(i2c_master_bus_handle_t i2c_bus, uint32_t dev_addr, esp_io_expander_handle_t *handle_ret);
|
||||
|
||||
/**
|
||||
* @brief I2C address of the TCA9554
|
||||
*
|
||||
* The 8-bit address format is as follows:
|
||||
*
|
||||
* (Slave Address)
|
||||
* ┌─────────────────┷─────────────────┐
|
||||
* ┌─────┐─────┐─────┐─────┐─────┐─────┐─────┐─────┐
|
||||
* | 0 | 1 | 0 | 0 | A2 | A1 | A0 | R/W |
|
||||
* └─────┘─────┘─────┘─────┘─────┘─────┘─────┘─────┘
|
||||
* └────────┯────────┘ └─────┯──────┘
|
||||
* (Fixed) (Hareware Selectable)
|
||||
*
|
||||
* And the 7-bit slave address is the most important data for users.
|
||||
* For example, if a chip's A0,A1,A2 are connected to GND, it's 7-bit slave address is 0100000b(0x20).
|
||||
* Then users can use `ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_000` to init it.
|
||||
*/
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_000 (0x20)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_001 (0x21)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_010 (0x22)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_011 (0x23)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_100 (0x24)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_101 (0x25)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_110 (0x26)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_111 (0x27)
|
||||
|
||||
|
||||
/**
|
||||
* @brief I2C address of the TCA9554A
|
||||
*
|
||||
* The 8-bit address format is as follows:
|
||||
*
|
||||
* (Slave Address)
|
||||
* ┌─────────────────┷─────────────────┐
|
||||
* ┌─────┐─────┐─────┐─────┐─────┐─────┐─────┐─────┐
|
||||
* | 0 | 1 | 1 | 1 | A2 | A1 | A0 | R/W |
|
||||
* └─────┘─────┘─────┘─────┘─────┘─────┘─────┘─────┘
|
||||
* └────────┯────────┘ └─────┯──────┘
|
||||
* (Fixed) (Hareware Selectable)
|
||||
*
|
||||
* And the 7-bit slave address is the most important data for users.
|
||||
* For example, if a chip's A0,A1,A2 are connected to GND, it's 7-bit slave address is 0111000b(0x38).
|
||||
* Then users can use `ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_000` to init it.
|
||||
*/
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_000 (0x38)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_001 (0x39)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_010 (0x3A)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_011 (0x3B)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_100 (0x3C)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_101 (0x3D)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_110 (0x3E)
|
||||
#define ESP_IO_EXPANDER_I2C_TCA9554A_ADDRESS_111 (0x3F)
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -0,0 +1,6 @@
|
||||
# The following lines of boilerplate have to be in your project's CMakeLists
|
||||
# in this exact order for cmake to work correctly
|
||||
cmake_minimum_required(VERSION 3.5)
|
||||
set(COMPONENTS main)
|
||||
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||
project(test_app_tca9554)
|
||||
@@ -0,0 +1,4 @@
|
||||
idf_component_register(
|
||||
SRCS "test_app_tca9554.c"
|
||||
REQUIRES unity
|
||||
)
|
||||
@@ -0,0 +1,6 @@
|
||||
## IDF Component Manager Manifest File
|
||||
dependencies:
|
||||
idf: ">=5.2"
|
||||
esp_io_expander_tca9554:
|
||||
version: "*"
|
||||
override_path: "../../../esp_io_expander_tca9554"
|
||||
@@ -0,0 +1,147 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/task.h"
|
||||
#include "unity.h"
|
||||
#include "unity_test_runner.h"
|
||||
#include "unity_test_utils_memory.h"
|
||||
#include "esp_system.h"
|
||||
#include "esp_log.h"
|
||||
#include "driver/i2c_master.h"
|
||||
#include "esp_io_expander_tca9554.h"
|
||||
|
||||
// Pinout for ESP32-S3-LCD-Ev-Board
|
||||
#define I2C_MASTER_SCL_IO 48 /*!< gpio number for I2C master clock */
|
||||
#define I2C_MASTER_SDA_IO 47 /*!< gpio number for I2C master data */
|
||||
#define I2C_MASTER_NUM I2C_NUM_0 /*!< I2C port number for master dev */
|
||||
#define I2C_ADDRESS ESP_IO_EXPANDER_I2C_TCA9554_ADDRESS_000
|
||||
/*!< I2C address of slave dev */
|
||||
|
||||
#define TEST_LOOP_CNT 10
|
||||
#define TEST_LOOP_DELAY_MS 500
|
||||
#define TEST_OUTPUT_PINS (IO_EXPANDER_PIN_NUM_0 | IO_EXPANDER_PIN_NUM_1)
|
||||
#define TEST_INPUT_PINS (IO_EXPANDER_PIN_NUM_2 | IO_EXPANDER_PIN_NUM_3)
|
||||
|
||||
static const char *TAG = "tca9554 test";
|
||||
static esp_io_expander_handle_t io_expander = NULL;
|
||||
static i2c_master_bus_handle_t i2c_handle = NULL;
|
||||
|
||||
static void i2c_bus_init(void)
|
||||
{
|
||||
const i2c_master_bus_config_t bus_config = {
|
||||
.i2c_port = I2C_MASTER_NUM,
|
||||
.sda_io_num = I2C_MASTER_SDA_IO,
|
||||
.scl_io_num = I2C_MASTER_SCL_IO,
|
||||
.clk_source = I2C_CLK_SRC_DEFAULT,
|
||||
};
|
||||
|
||||
esp_err_t ret = i2c_new_master_bus(&bus_config, &i2c_handle);
|
||||
TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "I2C install returned error");
|
||||
}
|
||||
|
||||
static void i2c_bus_deinit(void)
|
||||
{
|
||||
esp_err_t ret = i2c_del_master_bus(i2c_handle);
|
||||
TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "I2C uninstall returned error");
|
||||
}
|
||||
|
||||
static void i2c_dev_tca9554_init(void)
|
||||
{
|
||||
esp_err_t ret = esp_io_expander_new_i2c_tca9554(i2c_handle, I2C_ADDRESS, &io_expander);
|
||||
TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "TCA9554 create returned error");
|
||||
}
|
||||
|
||||
static void i2c_dev_tca9554_deinit(void)
|
||||
{
|
||||
esp_err_t ret = esp_io_expander_del(io_expander);
|
||||
TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "TCA9554 delete returned error");
|
||||
}
|
||||
|
||||
TEST_CASE("IO expander tca9554 test", "[tca9554]")
|
||||
{
|
||||
i2c_bus_init();
|
||||
i2c_dev_tca9554_init();
|
||||
|
||||
esp_err_t ret;
|
||||
/* Test output level function */
|
||||
ret = esp_io_expander_set_dir(io_expander, TEST_OUTPUT_PINS, IO_EXPANDER_OUTPUT);
|
||||
TEST_ASSERT_EQUAL(ESP_OK, ret);
|
||||
// Print state
|
||||
ret = esp_io_expander_print_state(io_expander);
|
||||
TEST_ASSERT_EQUAL(ESP_OK, ret);
|
||||
for (int i = 0; i < TEST_LOOP_CNT; i++) {
|
||||
// Set level to 0
|
||||
ESP_LOGI(TAG, "Set level to 0");
|
||||
ret = esp_io_expander_set_level(io_expander, TEST_OUTPUT_PINS, 0);
|
||||
TEST_ASSERT_EQUAL(ESP_OK, ret);
|
||||
vTaskDelay(pdMS_TO_TICKS(TEST_LOOP_DELAY_MS / 2));
|
||||
// Set level to 1
|
||||
ESP_LOGI(TAG, "Set level to 1");
|
||||
ret = esp_io_expander_set_level(io_expander, TEST_OUTPUT_PINS, 1);
|
||||
TEST_ASSERT_EQUAL(ESP_OK, ret);
|
||||
vTaskDelay(pdMS_TO_TICKS(TEST_LOOP_DELAY_MS / 2));
|
||||
}
|
||||
|
||||
/* Test output level function */
|
||||
uint32_t input_level_mask = 0;
|
||||
ret = esp_io_expander_set_dir(io_expander, TEST_INPUT_PINS, IO_EXPANDER_INPUT);
|
||||
TEST_ASSERT_EQUAL(ESP_OK, ret);
|
||||
// Print state
|
||||
ret = esp_io_expander_print_state(io_expander);
|
||||
TEST_ASSERT_EQUAL(ESP_OK, ret);
|
||||
for (int i = 0; i < TEST_LOOP_CNT; i++) {
|
||||
// Get input level
|
||||
ret = esp_io_expander_get_level(io_expander, TEST_INPUT_PINS, &input_level_mask);
|
||||
TEST_ASSERT_EQUAL(ESP_OK, ret);
|
||||
ESP_LOGI(TAG, "Input level mask: 0x%02" PRIX32, input_level_mask);
|
||||
vTaskDelay(pdMS_TO_TICKS(TEST_LOOP_DELAY_MS));
|
||||
}
|
||||
|
||||
i2c_dev_tca9554_deinit();
|
||||
i2c_bus_deinit();
|
||||
vTaskDelay(10); // Give FreeRTOS some time to free its resources
|
||||
}
|
||||
|
||||
#define TEST_MEMORY_LEAK_THRESHOLD (500)
|
||||
|
||||
void setUp(void)
|
||||
{
|
||||
unity_utils_set_leak_level(TEST_MEMORY_LEAK_THRESHOLD);
|
||||
unity_utils_record_free_mem();
|
||||
}
|
||||
|
||||
void tearDown(void)
|
||||
{
|
||||
unity_utils_evaluate_leaks();
|
||||
}
|
||||
|
||||
void app_main(void)
|
||||
{
|
||||
/**
|
||||
* ________ ______ ______ ______ _______ _______ __ __ ___ ______ ___
|
||||
* | \ / \ / \ / \ | \ | \| \ | \ / \ / \ | \
|
||||
* \$$$$$$$$| $$$$$$\| $$$$$$\| $$$$$$\| $$$$$$$ | $$$$$$$| $$ | $$ / $$$| $$$$$$\ \$$$\
|
||||
* | $$ | $$ \$$| $$__| $$| $$__/ $$| $$____ | $$____ | $$__| $$| $$ | $$__| $$ \$$\
|
||||
* | $$ | $$ | $$ $$ \$$ $$| $$ \ | $$ \| $$ $$| $$ | $$ $$ | $$
|
||||
* | $$ | $$ __ | $$$$$$$$ _\$$$$$$$ \$$$$$$$\ \$$$$$$$\\$$$$$$$$| $$ | $$$$$$$$ | $$
|
||||
* | $$ | $$__/ \| $$ | $$| \__/ $$| \__| $$| \__| $$ | $$ \$$\_ | $$ | $$ _/ $$
|
||||
* | $$ \$$ $$| $$ | $$ \$$ $$ \$$ $$ \$$ $$ | $$ \$$ \| $$ | $$| $$
|
||||
* \$$ \$$$$$$ \$$ \$$ \$$$$$$ \$$$$$$ \$$$$$$ \$$ \$$$ \$$ \$$ \$$$
|
||||
*
|
||||
*/
|
||||
printf(" ________ ______ ______ ______ _______ _______ __ __ ___ ______ ___\r\n");
|
||||
printf("| \\ / \\ / \\ / \\ | \\ | \\| \\ | \\ / \\ / \\ | \\\r\n");
|
||||
printf(" \\$$$$$$$$| $$$$$$\\| $$$$$$\\| $$$$$$\\| $$$$$$$ | $$$$$$$| $$ | $$ / $$$| $$$$$$\\ \\$$$\\\r\n");
|
||||
printf(" | $$ | $$ \\$$| $$__| $$| $$__/ $$| $$____ | $$____ | $$__| $$| $$ | $$__| $$ \\$$\\\r\n");
|
||||
printf(" | $$ | $$ | $$ $$ \\$$ $$| $$ \\ | $$ \\| $$ $$| $$ | $$ $$ | $$\r\n");
|
||||
printf(" | $$ | $$ __ | $$$$$$$$ _\\$$$$$$$ \\$$$$$$$\\ \\$$$$$$$\\\\$$$$$$$$| $$ | $$$$$$$$ | $$\r\n");
|
||||
printf(" | $$ | $$__/ \\| $$ | $$| \\__/ $$| \\__| $$| \\__| $$ | $$ \\$$\\_ | $$ | $$ _/ $$\r\n");
|
||||
printf(" | $$ \\$$ $$| $$ | $$ \\$$ $$ \\$$ $$ \\$$ $$ | $$ \\$$ \\| $$ | $$| $$\r\n");
|
||||
printf(" \\$$ \\$$$$$$ \\$$ \\$$ \\$$$$$$ \\$$$$$$ \\$$$$$$ \\$$ \\$$$ \\$$ \\$$ \\$$$\r\n");
|
||||
unity_run_menu();
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y
|
||||
CONFIG_ESP_TASK_WDT_EN=n
|
||||
CONFIG_FREERTOS_HZ=1000
|
||||
CONFIG_FREERTOS_TIMER_TASK_STACK_DEPTH=4096
|
||||
Reference in New Issue
Block a user