Mcp23017_lib_rp2040_sdk

0 forks

2 stars

Free

What is mcp23017_lib_rp2040_sdk?

mcp23017_lib_rp2040_sdk is a specialized software library developed by moreElectronicProjects, designed to facilitate the integration and management of the MCP23017 IO expander with the Raspberry Pi RP2040 platform. This library provides a range of functions that enable users to control and configure the MCP23017 chip, which is an I2C-based device used to expand the number of input/output pins available to a microcontroller. The library is aimed at developers who need to interface with hardware components efficiently, especially those working with the Raspberry Pi RP2040 microcontroller.

How to Use mcp23017_lib_rp2040_sdk

To get started with mcp23017_lib_rp2040_sdk, you first need to install it by incorporating the library into your project setup. This involves downloading the library files into your project directory and updating your CMake file to include the library source directory. The installation is straightforward and does not require any dependencies beyond the Raspberry Pi RP2040 C SDK.

Steps to Use:

Installation:
- Download the library and place it in your project directory.
- Modify your CMake configuration by adding:
```
add_subdirectory({path_to_mcp23017_lib_folder}/src)
```
  Replace {path_to_mcp23017_lib_folder} with the actual path to the library files.
Initialization:
- Use the mcp23017_init function to initialize the MCP23017 chip. This step is crucial as it sets up the chip for further operations. Ensure the function returns 0, indicating successful initialization.
Functionality:
- Utilize the library's comprehensive set of functions to configure the chip's general settings, manage GPIO pins, and set up interrupts. Functions are available for both general chip configuration and specific GPIO pin adjustments.
Examples:
- The library includes example scripts demonstrating how to use the various functions effectively. These examples can be found in the library's examples folder within your project directory.

Key Features of mcp23017_lib_rp2040_sdk

Comprehensive IO Management: Provides functions to manage and configure all aspects of the MCP23017's IO capabilities, including setting pin directions, polarity, and pull-up resistors.
Interrupt Handling: The library allows for detailed configuration of interrupt features, enabling users to set, clear, and manage interrupts on specific pins or the entire GPIO bank.
Pin-Level Control: Offers granular control over individual pins, allowing developers to set or get the state of specific pins. This feature can be toggled on or off in the project's build configuration.
Flexible Configuration: Users can choose to enable or disable individual pin functions at compile time, optimizing the library for the specific needs of the project.
Ease of Integration: Designed to integrate seamlessly with projects using the Raspberry Pi RP2040 platform, requiring minimal setup for immediate use.

mcp23017_lib_rp2040_sdk is a powerful tool for developers needing to extend the IO capabilities of their projects using the MCP23017 expander, offering a robust set of features for precise hardware control and integration.

Introduction

This repository contains the code which implements a library for the MCP23017 IO expander.

Installation

This library requires no additional dependencies outside of the Raspberry Pi RP2040 C SDK. To install this library, download this repository into your project and add the following lines to your project's CMake file:

add_subdirectory({path_to_mcp23017_lib_folder}/src)

where {path_to_mcp23017_lib_folder} is replaced with the path to the library.

Usage

This section describes the functions implemented by this library. All functions have the same first two arguments. The following table lists these arguments and their purpose. | Parameter number | Parameter Type | Parameter Name | Parameter Description | | 1 | i2c_inst_t* | hardware_i2c | A pointer to the RP2040's i2c hardware peripheral which the MCP23017 is connected to. | | 2 | uint8_t | mcp23017_addr | The address which the MCP23017 is listening on. This is in the form of 0b0100xxx, where xxx is address pins A2-A0 on the IC respectively. | In the following sections, to get more information on a given function, see the comments in the header file located at src/mcp23017_lib.h.

Initialization

The chip must be initialized prior to using any other functions. This can be achieved by the mcp23017_init function. This function returns 0 if the initialization was successful and 1 otherwise. If the function returns 1, do not continue to use the library as the chip can be in an uninitialized state.

General Chip Configuration

The following functions allows for general configuration of the chip.

mcp23017_set_int_mirror
mcp23017_get_int_mirror
mcp23017_set_int_open_drain
mcp23017_get_int_open_drain
mcp23017_set_int_polarity
mcp23017_get_int_polarity

Configuring the Pins

The following functions allows for configuration of the chip's IO pins.

mcp23017_set_dir_gpioa
mcp23017_get_dir_gpioa
mcp23017_set_dir_gpiob
mcp23017_get_dir_gpiob
mcp23017_set_dir_gpioa_pin
mcp23017_get_dir_gpioa_pin
mcp23017_set_dir_gpiob_pin
mcp23017_get_dir_gpiob_pin
mcp23017_set_polarity_gpioa
mcp23017_get_polarity_gpioa
mcp23017_set_polarity_gpiob
mcp23017_get_polarity_gpiob
mcp23017_set_polarity_gpioa_pin
mcp23017_get_polarity_gpioa_pin
mcp23017_set_polarity_gpiob_pin
mcp23017_get_polarity_gpiob_pin
mcp23017_set_pullup_gpioa
mcp23017_get_pullup_gpioa
mcp23017_set_pullup_gpiob
mcp23017_get_pullup_gpiob
mcp23017_set_pullup_gpioa_pin
mcp23017_get_pullup_gpioa_pin
mcp23017_set_pullup_gpiob_pin
mcp23017_get_pullup_gpiob_pin

GPIO Input and Output

The following functions allows for reading and writing to the chip's GPIO.

mcp23017_set_pins_gpioa
mcp23017_get_pins_gpioa
mcp23017_set_pins_gpiob
mcp23017_get_pins_gpiob
mcp23017_set_pins_gpioa_pin
mcp23017_get_pins_gpioa_pin
mcp23017_set_pins_gpiob_pin
mcp23017_get_pins_gpiob_pin

Interrupt Configuration

The following functions allows for configuration of the chip's interrupt capabilities.

mcp23017_set_int_on_change_gpioa
mcp23017_get_int_on_change_gpioa
mcp23017_set_int_on_change_gpiob
mcp23017_get_int_on_change_gpiob
mcp23017_set_int_on_change_gpioa_pin
mcp23017_get_int_on_change_gpioa_pin
mcp23017_set_int_on_change_gpiob_pin
mcp23017_get_int_on_change_gpiob_pin
mcp23017_set_default_int_compare_gpioa
mcp23017_get_default_int_compare_gpioa
mcp23017_set_default_int_compare_gpiob
mcp23017_get_default_int_compare_gpiob
mcp23017_set_default_int_compare_gpioa_pin
mcp23017_get_default_int_compare_gpioa_pin
mcp23017_set_default_int_compare_gpiob_pin
mcp23017_get_default_int_compare_gpiob_pin
mcp23017_set_int_control_gpioa
mcp23017_get_int_control_gpioa
mcp23017_set_int_control_gpiob
mcp23017_get_int_control_gpiob
mcp23017_set_int_control_gpioa_pin
mcp23017_get_int_control_gpioa_pin
mcp23017_set_int_control_gpiob_pin
mcp23017_get_int_control_gpiob_pin

Interrupt State

The following functions allows for querying the current state of the interrupt pins.

mcp23017_get_int_flag_gpioa
mcp23017_get_int_captured_val_gpioa
mcp23017_get_int_flag_gpiob
mcp23017_get_int_captured_val_gpiob
mcp23017_get_int_flag_gpioa_pin
mcp23017_get_int_captured_val_gpioa_pin
mcp23017_get_int_flag_gpiob_pin
mcp23017_get_int_captured_val_gpiob_pin

Additional Features

By default, this library implements functions which allow the programmer to modify a single pin. For example, the programmer can modify the output of a single pin with the following command to set pin 7 on GPIO A to a logic LOW.

mcp23017_set_pins_gpioa_pin(mcp23017_i2c, mcp23017_addr, 7, 0);

All such functions can be identified as the end in _pin and require an additional parameter after the MCP23017_addr to specify the pin to modify or get the state of. In case the programmer does not need these individual pin functions, these functions can be removed at compile time by adding the following line to you project's Cmake file:

set(mcp23017_lib_enable_individual_pin_functions OFF)

Examples

This repository also contains examples on using this library. They can be found in the examples folder of this repository.

How to Use

To use the mcp23017_lib_rp2040_sdk, follow these steps:

Visit https://github.com/moreElectronicProjects/mcp23017_lib_rp2040_sdkhttps://github.com/moreEl...
Follow the setup instructions to create an account (if required)
Connect the MCP server to your Claude Desktop application
Start using mcp23017_lib_rp2040_sdk capabilities within your Claude conversations

Additional Information

Created

February 26, 2023

Company

moreElectronicProjects

Related MCP Servers

Start building your own MCP Server

Interested in creating your own MCP Server? Check out the official documentation and resources.

Learn More