EtherCard 项目使用教程

EtherCard 项目使用教程

EtherCard EtherCard is an IPv4 driver for the ENC28J60 chip, compatible with Arduino IDE 项目地址: https://gitcode.com/gh_mirrors/et/EtherCard

1. 项目目录结构及介绍

EtherCard 项目的目录结构如下：

EtherCard/
├── docs/
├── examples/
├── src/
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── keywords.txt
├── library.json
└── library.properties

目录介绍：

• docs/：包含项目的文档文件，通常是一些说明文档或API文档。
• examples/：包含多个示例代码，展示了如何使用 EtherCard 库进行网络通信。
• src/：包含项目的源代码文件，主要是 C++ 和 C 语言编写的驱动代码。
• .gitignore：Git 的忽略文件，用于指定哪些文件或目录不需要被版本控制。
• .travis.yml：Travis CI 的配置文件，用于自动化测试和构建。
• CONTRIBUTING.md：贡献指南，指导开发者如何为项目贡献代码。
• LICENSE：项目的开源许可证，EtherCard 使用 GPL-2.0 许可证。
• README.md：项目的说明文件，包含项目的基本介绍、安装方法和使用说明。
• keywords.txt：包含项目的关键词，用于 Arduino IDE 中的库搜索。
• library.json：Arduino 库的元数据文件，包含库的版本、作者等信息。
• library.properties：Arduino 库的属性文件，包含库的名称、版本、作者等信息。

2. 项目启动文件介绍

EtherCard 项目的启动文件主要是 src/ 目录下的源代码文件。这些文件包含了驱动 ENC28J60 芯片的底层代码。以下是一些关键文件的介绍：

• EtherCard.cpp：EtherCard 库的主要实现文件，包含了网络通信的核心功能。
• EtherCard.h：EtherCard 库的头文件，定义了库的接口和数据结构。

启动流程：

1. 包含头文件：在 Arduino 项目中，首先需要包含 EtherCard.h 头文件。
2. 初始化库：调用 ether.begin() 函数初始化 EtherCard 库，配置网络接口。
3. 配置网络：可以使用 DHCP 或静态 IP 地址配置网络。
4. 发送/接收数据：使用 EtherCard 提供的 API 进行网络通信。

3. 项目的配置文件介绍

EtherCard 项目的配置文件主要包括以下几个：

• library.json：包含库的元数据，如版本号、作者、依赖项等。
• library.properties：包含库的基本属性，如库的名称、版本、作者等。
• .travis.yml：Travis CI 的配置文件，用于自动化测试和构建。

配置文件示例：

library.json

{
  "name": "EtherCard",
  "version": "1.1.0",
  "keywords": "ethernet, enc28j60",
  "description": "Ethernet driver for the ENC28J60 chip, compatible with Arduino IDE",
  "repository": {
    "type": "git",
    "url": "https://github.com/njh/EtherCard.git"
  },
  "authors": [
    {
      "name": "Nicholas Humfrey",
      "email": "njh@aelius.com",
      "url": "http://www.aelius.com/njh/",
      "maintainer": true
    }
  ],
  "license": "GPL-2.0",
  "frameworks": "arduino",
  "platforms": "atmelavr"
}

library.properties

name=EtherCard
version=1.1.0
author=Nicholas Humfrey
maintainer=Nicholas Humfrey <njh@aelius.com>
sentence=Ethernet driver for the ENC28J60 chip, compatible with Arduino IDE
paragraph=EtherCard is a driver for the Microchip ENC28J60 chip, compatible with Arduino IDE.
category=Communication
url=https://github.com/njh/EtherCard
architectures=avr

.travis.yml

language: cpp
compiler:
  - gcc
before_script:
  - echo "Setting up environment"
script:
  - echo "Running tests"
after_success:
  - echo "Tests passed"

这些配置文件帮助开发者了解库的基本信息，并确保库在不同平台和框架下的兼容性。

EtherCard EtherCard is an IPv4 driver for the ENC28J60 chip, compatible with Arduino IDE 项目地址: https://gitcode.com/gh_mirrors/et/EtherCard