Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/ch9121
CH9121 full function driver library for general MCU and Linux.
https://github.com/libdriver/ch9121
c ch9121 ethernet full-function-driver linux mcu uart
Last synced: 12 days ago
JSON representation
CH9121 full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/ch9121
- Owner: libdriver
- License: mit
- Created: 2023-04-15T19:14:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-31T11:19:15.000Z (2 months ago)
- Last Synced: 2024-10-11T00:19:16.348Z (28 days ago)
- Topics: c, ch9121, ethernet, full-function-driver, linux, mcu, uart
- Language: C
- Homepage: https://www.libdriver.com
- Size: 2.83 MB
- Stars: 35
- Watchers: 7
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
## LibDriver CH9121
[](/misra/README.md) [](https://www.libdriver.com/docs/ch9121/index.html) [](/LICENSE)
CH9121 is a chip realizing transparent transmission between network and UART. It integrates TCP/IP protocol stack, which can realize bidirectional transparent transmission between network data packets and serial data. It has 4 working modes: TCP CLIENT, TCP SERVER, UDP CLIENT and UDP SERVER. The serial baud rate can be up to 921600bps. It can be easily configured by upper computer software or serial commands, which is convenient and quick.
LibDriver CH9121 is the full function driver of CH9121 launched by LibDriver.It provides tcp server, tcp client, udp server, udp client and other functions. LibDriver is MISRA compliant.
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example basic](#example-basic)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver CH9121 source files.
/interface includes LibDriver CH9121 UART platform independent template.
/test includes LibDriver CH9121 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver CH9121 sample code.
/doc includes LibDriver CH9121 offline document.
/datasheet includes CH9121 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
### Install
Reference /interface UART platform independent template and finish your platform UART driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
### Usage
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#### example basic
```C
#include "driver_ch9121_basic.h"
char data[49];
uint16_t l;
uint8_t dest_ip[4] = {192, 168, 1, 10};
uint16_t dest_port = 1000;
uint8_t gateway[4] = {192, 168, 1, 1};
uint8_t mask[4] = {255, 255, 255, 0};
ch9121_mode_t mode = CH9121_MODE_TCP_CLIENT;
uint8_t source_ip[4] = {192, 168, 1, 230};
uint16_t source_port = 2000;
ch9121_port_t uart_port = CH9121_PORT1;
/* net init */
if (ch9121_basic_init() != 0)
{
return 1;
}
...
/* this is optional */
if (ch9121_basic_config(uart_port, mode,
source_ip, source_port,
mask, gateway,
dest_ip, dest_port) != 0)
{
(void)ch9121_basic_deinit();
return 1;
}
...
/* net write */
if (ch9121_basic_write((uint8_t *)"LibDriver", strlen((char*)"LibDriver")) != 0)
{
(void)ch9121_basic_deinit();
return 1;
}
...
/* 48 byte */
l = 48;
memset(data, 0, sizeof(char) * 48);
/* net read */
if (ch9121_basic_read((uint8_t *)data, &l) != 0)
{
(void)ch9121_basic_deinit();
return 1;
}
/* output */
ch9121_interface_debug_print("ch9121: net read %s.\n", data);
...
/* net deinit */
if (ch9121_basic_deinit() != 0)
{
return 1;
}
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/ch9121/index.html](https://www.libdriver.com/docs/ch9121/index.html).
Offline documents: /doc/html/index.html.
### Contributing
Please refer to CONTRIBUTING.md.
### License
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
### Contact Us
Please send an e-mail to [email protected].