NodeMCU-API中文说明 .pdf

NodeMCU是一种开源的物联网平台，它使用Lua脚本语言作为编程语言，同时提供了丰富的模块化API，方便开发者进行物联网项目开发。NodeMCU API提供了多个模块，用于控制硬件，执行网络通信等功能。这份《NodeMCU-API中文说明》文档详细列出了Version 0.9.5（发布于2015年2月13日）的API中文使用说明，内容覆盖了从基础的GPIO操作到复杂网络通信的各种函数和方法。 ### NodeMCU模块概览 NodeMCU提供了以下主要模块： - **node模块**：提供了重启、深度睡眠、获取信息、芯片ID、FLASH ID、堆内存信息、按键读取、LED控制等基础信息和操作功能。 - **file模块**：用于文件系统的操作，包括文件的删除、打开、关闭、读取、写入、刷新缓冲区、移动文件指针和列出目录下的文件。 - **wifi模块**：涉及到WiFi网络的设置，包括网络模式设定、启动与停止智能扫描、配置和连接到接入点、获取网络信息、自动连接设置等。 - **timer模块**：提供定时器功能，包括延时、获取当前时间、设置和清除定时器警报。 - **GPIO模块**：控制通用输入输出端口，包括端口模式设置、读取和写入值、触发中断等。 - **PWM模块**：控制脉冲宽度调制，包括PWM通道的配置、打开和关闭、启动和停止调制、设置和获取时钟频率、占空比。 - **net模块**：用于网络编程，包括创建服务器、客户端连接、监听和接收、发送和断开连接。 - **dns模块**：用于域名解析。 - **i2c模块**：提供了I2C总线的配置、启动、停止、设置地址、读写操作等功能。 - **adc模块**：用于模拟数字转换，可以读取模拟输入的值。 - **uart模块**：提供了串行通讯接口的配置和数据接收发送功能。 - **onewire模块**：实现单总线协议，用于读写设备如温度传感器。 - **bit模块**：提供了位操作函数，包括位取反、位与、位或、位异或、位左移、右移、算术右移、位测试、位置位、位清零、位检查等。 - **spi模块**：提供了SPI总线的配置和数据发送、接收函数。 - **mqtt模块**：用于实现消息队列遥测传输(MQTT)协议，提供发布/订阅消息模式，适用于无线遥控和传感器数据采集。 ### 具体模块及函数说明 **node模块**：包含一些用于NodeMCU系统管理的函数，例如`node.restart()`用于重启设备，`node.dsleep()`可以让设备进入深度睡眠模式。 **file模块**：通过`file.remove()`函数可以删除指定的文件，`file.open()`和`file.close()`用于打开和关闭文件，`file.readline()`和`file.writeline()`用于读写单行文本。 **wifi模块**：`wifi.setmode()`设置工作模式，`wifi.sta.config()`和`wifi.sta.connect()`用于配置和连接到WiFi网络，`wifi.ap.config()`用于设置AP模式下的配置。 **timer模块**：`tmr.delay()`提供毫秒级的延时功能，`tmr.now()`返回当前的系统时间，`tmr.alarm()`可以设置一个定时器警报。 **GPIO模块**：`gpio.mode()`用于设置GPIO引脚模式，`gpio.write()`用于向引脚写入高低电平，`gpio.trig()`用于设置引脚触发模式。 **PWM模块**：通过`pwm.setup()`设置PWM通道参数，`pwm.start()`和`pwm.stop()`用于开启和关闭PWM输出。 **net模块**：`net.createServer()`创建一个服务器实例，`net.createConnection()`创建一个连接实例，用于进行网络数据的收发。 **dns模块**：提供域名与IP地址转换的功能。 **i2c模块**：用于在I2C总线上进行设备通信，包括`i2c.setup()`设置总线参数，`i2c.address()`设置设备地址。 **adc模块**：用于读取模拟信号的值，如通过`adc.read()`获取。 **uart模块**：实现串行通信，`uart.setup()`配置串行参数，`uart.on()`设置接收回调。 **onewire模块**：用于与单总线设备通信，如DS18B20温度传感器，提供`ow.setup()`、`ow.read()`等操作。 **bit模块**：提供了一系列操作单个位的函数，这对于位操作和硬件控制非常有用。 **spi模块**：提供SPI总线的读写功能，如`spi.setup()`用于配置SPI总线，`spi.send()`和`spi.recv()`用于数据的发送和接收。 **mqtt模块**：`mqtt.Client()`创建MQTT客户端实例，实现消息的发布和订阅。 这份文档为开发人员提供了一个完整的参考，涵盖了所有NodeMCU模块的API，便于开发者根据需要选择合适的函数进行编程。由于文档的年代较早（2015年），因此在使用时还需要考虑与最新的NodeMCU固件版本的兼容性问题。此外，由于文档部分文字可能存在OCR扫描识别错误，使用时需要结合上下文和官方资料进行验证和修正。