image.png

中文說明

https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_cn
(轉自http://blog.csdn.net/dustintime/article/details/54914054)

本地玩具

adc, file, gpio, i2c, node, 1-wire, pwm, spi, timer, uart, u8g, bit, cron, pcm, ads1115, RTC time, switec, ucg

物聯網

wifi, net, mqtt, file, node, RTC time, RTC mem, RTC fifo, sjson, bit, http, encodr, crypto, mDNS, sntp, websocket, wps, , smtp, socket,

LED燈帶

ws2801 or ws2812 or TM1829 or AP102

=======================================

ADC

Analog-to-Digital Converter 數模轉化, ADC模塊提供對內置ADC的訪問
在ESP8266只有一個通道，這是復用電池電壓。根據“esp init data”（107字節）可以使用ADC讀取外部電壓，或讀取system電壓（vdd33），但不能同時使用。

ADS1115

這個模塊提供的ADS1115 16位精密模數轉換器。用于制作邏輯分析儀

ADXL345

這個模塊提供的ADXL345三軸加速度計。

AMazon320

這個模塊提供的am2320濕度和溫度傳感器，使用I2C接口。

image.png

APA102

該模塊提供了Lua訪問apa102 RGB LED的功能是類似通用WS2812尋址LED(ws2812是另一個)。

BIT

位操作的支持，在32位整數。

BME280

這個模塊提供了一個簡單的接口bme280 /溫度/壓力/ BMP280空氣濕度傳感器（博世傳感器）。
注意，你必須調用 init() 在讀取數值之前！

BMP085

這個模塊提供的溫度和壓力傳感器BMP085。該模塊還與BMP180一同工作。

CJson

該模塊已被SJson替代。它提供的功能的一個超集。所有涉及CJson都可用SJson替代

CoAP

該模塊根據協議CoAP協議提供了一個簡單的實現。基本終端服務器部分是基于microcoap，和許多其他的代碼參考libcoap。
該模塊實現客戶端和服務器端。客戶機部分支持GET/PUT/POST/DELETE。服務器可以注冊Lua函數和變量。沒有觀察或發現支持。

Cron

Cron-like 調度模塊
這個模塊需要RTC時間來正確操作。不要忘了包括rtctime模塊。

crypto

密碼模塊提供了處理加密算法的各種功能。
下面的加密/解密算法/模式支持：128位AES在ECB模式“aes-ecb”（不推薦）128位AES CBC模式“AES-CBC”
下面的哈希算法的支持：- MD2（默認情況下不可用，必須開啟在 app/include/user_config.h）- MD5 SHA1 - SHA256，SHA384，SHA512（除非禁止在 app/include/user_config.h 拗口, "unless disable"到底要說啥）

dht

dht溫濕度傳感器

encoder

編碼器模塊提供字節碼的編碼和解碼的各種功能。Base64編解碼, Hex編解碼

enduser

這個模塊提供了一個簡單的方法來配置ESP8266芯片不使用串行接口或預編程的WiFi憑據到芯片上。貌似是用來連wifi用的

file

文件模塊提供對文件系統及其單個文件的訪問。文件系統是一個扁平文件管理系統，沒有子目錄/文件夾的概念。除了在內部Flash的SPIFFS文件系統，這個模塊也可以在外部SD卡的FAT分區, 如果FatFS啟用的情況下。

gdbstub

gdb什么的不懂

gpio

玩過51單片機和stm以及樹莓派, arduino的都應該知道的東西
這個模塊提供的GPIO（通用輸入/輸出）子系統。
所有的訪問是基于I/O的nodemcu開發套件的指數，沒有內部的GPIO引腳。例如，在開發套件D0引腳映射到內部的GPIO引腳16。
如果不使用nodemcu開發套件，請參考如下指標?GPIO映射GPIO引腳圖。

從電路背面看從GPIO16開始是一個向下的U型結構的順序排列的io接口
[*] D0(GPIO16) 只能用于讀寫, 不支持開漏輸出,中斷,pwm, i2c和 ow

hdc1080

這個模塊提供的hdc1080低功耗、高精度的數字濕度傳感器與溫度傳感器。

hmc5883L

這個模塊提供的HMC5883L三軸數字羅盤。

http

基本HTTP客戶端模塊，它提供了一個通過HTTP來 GET/POST/PUT/DELETE 的接口，以及定制的請求。由于對ESP8266內存限制，支持的page/body的大小是受可用內存的限制。試圖接收大于此頁的頁將失敗。如果較大的page/body的大小是必要的，考慮使用net.createconnection()和流。

hx711

這個模塊提供一個 HX711 load cell amplifier/ADC。hx711是一個不昂貴的24bit ADC的可編程128x，64x，32x增益。目前只信道A在128x增益的支持。

i2c

I2C的參考設計使用一個7位元長度的位址空間但保留了16個位址，所以在一組總線最多可和112個節點通訊。常見的I2C總線依傳輸速率的不同而有不同的模式：標準模式（100 Kbit/s）、低速模式（10 Kbit/s），但時脈頻率可被允許下降至零，這代表可以暫停通訊。而新一代的I2C總線可以和更多的節點（支援10位元長度的位址空間）以更快的速率通訊：快速模式（400 Kbit/s）、高速模式（3.4 Mbit/s）。
雖然最大的節點數目是被位址空間所限制住，但實際上也會被總線上的總電容所限制住，一般而言為400 pF。

L3G4200D

這個模塊提供的三軸數字陀螺儀L3G4200D。

mDNS

組播DNS作為卓悅/探測部分。這允許系統識別自己和他們在局域網上提供的服務。然后客戶機能夠發現這些系統并連接到它們。

mqtt

客戶端堅持版本3.1.1 MQTT協議。確保你的經紀人的支持是版本3.1.1正確配置。客戶與經紀人運行MQTT 3.1向后兼容。

net

TLS操作被移動到TLS模塊。

node

節點模塊提供對系統級功能的訪問，如休眠、重啟和各種信息和IDS。

ow(1-Wire)

單總線, 此模塊提供了與單總線設備通信總線系統一起工作的功能。

pcm

通過不同的末端播放聲音。

perf

此模塊為應用程序提供簡單的性能度量。它每隔50微秒粗略地對程序計數器進行采樣，并建立它所找到的值的直方圖。由于只有少量的內存來存儲直方圖，用戶可以指定哪個區域的代碼是感興趣的。默認是包含代碼的整個flash。一旦確定了熱點，那么可以用不同的區域和不同的分辨率重復運行，以獲得所需的信息。

pwm

脈沖寬度調制是一種模擬控制方式，其根據相應載荷的變化來調制晶體管基極或MOS管柵極的偏置，來實現晶體管或MOS管導通時間的改變，從而實現開關穩壓電源輸出的改變。這種方式能使電源的輸出電壓在工作條件變化時保持恒定，是利用微處理器的數字信號對模擬電路進行控制的一種非常有效的技術。

rc

??

ifswitch

模塊操作433 / 315Mhz設備如電源插座、繼電器、等，這將與所有流行的低成本電源插座插座，最有可能的工作SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527 or HS1527 芯片組
該模塊采用了一些代碼從原來的遙控開關Arduino庫但NodeMCU和Arduino并不完全兼容。這就要求混凝土開關被改寫成rfswitch nodemcu lua的支持。

rotary

這個模塊可以讀取廉價的旋轉編碼器開關的狀態。這些可以在一美元或兩美元的所有標準位置買到。它們是五針裝置，其中三用于格雷碼旋轉編碼器，兩個用于推送開關。這些開關通常用于汽車音響系統。
這些開關沒有絕對位置，但只編碼順時針/逆時針旋轉的位置數。利用該模塊，連接通用的引腳上的正交編碼器的地面和A和B階段的nodemcu。一個引腳的按鍵開關也應該接地和其他引腳連接到nodemcu。

rtcfifo

的rtcfifo模塊實現了一個第一，先出存儲用于傳感器的讀數。顧名思義，它是由RTC用戶內存支持的，因此可以在深睡眠周期中存活。從概念上講，它可以被看作是時間戳、名稱、值}元組的循環數組。在內部，它使用空間優化的存儲格式，允許保存最多數量的樣本。這有幾個權衡，因此不是一個解決方案適合所有。尤其是:
. 時間戳存儲二精度。
. 采樣頻率必須至少每8.5分鐘一次。這是用于時間戳的delta壓縮的副作用。
. 值限制為16位精度，但有一個單獨的字段存儲e-N乘數。即使在使用非常小的值時，也允許高保真。有效范圍在 1e-7 到 65535。

rtcmem

的rtcmem模塊提供的RTC（實時時鐘）基本訪問存儲器。
在ESP8266 RTC寄存器包含內存中生存的深度睡眠，使他們保持狀態，整個睡眠周期非常有用。這些記憶是保留給系統使用，但128個插槽（每個32bit寬）可申請使用。此模塊提供對這些的讀寫訪問。
由于可用內存量非常有限，沒有機構仲裁使用特定的插槽。最終用戶應該知道哪些內存被用于什么，以及避免沖突。注意一些lua模塊聲稱某些時段。
這是一個同伴的rtctime rtcfifo模塊和模塊。

rtctime

RTC是多種名詞的縮寫，如：實時時鐘（Real-Time Clock）、美國資產重組托管公司（Resolution Trust Corporation）、 協作軟件交付環境（IBM Rational Team Concert）、響應時間補償（Response Time Compensation）、實時通訊（Real-time communications）、 雷達跟蹤中心（Radar TrackingCentre）。

si7021

這個模塊提供的si7021濕度和溫度傳感器。

sigma delta

此模塊提供對∑-Δ組件的訪問。這是一個硬件信號發生器，可以傳送到任何的GPIO引腳0除外。

sjson

JSON支持模塊。允許對JSON進行編碼和解碼。

sntp

SNTP模塊實現了一個簡單網絡時間協議的客戶端。這包括對“選播”NTP模式的支持，如果在網絡中由NTP服務器支持，就不需要知道NTP服務器的IP地址。默認情況下，這將使用服務器0.nodemcu.pool.ntp.org通過3.nodemcu.pool.ntp.org。這些服務器幾乎適用于幾乎所有的用途。

somfy

該模塊提供了通過一個射頻發射機的一個簡單的接口來控制尚飛簾（433.42兆赫）。它是基于nickduino尚飛遠程Arduino skecth。
所使用的硬件是標準的433兆赫射頻發射機。不幸的是，這些芯片通常傳送在他433.92Mhz所以晶體諧振器的頻率應與433.42 MHz諧振器雖然有些報道甚至與原來的晶體工作取代。

spi

發送和接收的所有事務都是最重要的比特優先和最不重要的最后一個。對底層硬件的技術細節是指metalphreak ESP8266 HSPI的文章。

struct

該模塊提供基本的設施將Lua值與C結構。它的主要功能是struct.pack，其中包多的Lua值為結構如弦；和struct.unpack，解壓縮多個lua值從一個給定的結構如弦。

switec

這個模塊控制switec 27（或兼容）儀表步進電機。這些是現代汽車儀表中使用的步進電機。它們非常便宜，可以在你最喜歡的拍賣網站或中國購物網站上找到。有各種各樣的雙軸，也就是說，有兩個步進電機驅動兩個同心軸，所以你可以從同一個軸上安裝兩個針。

tcs34725

這個模塊提供了一個簡單的接口tcs34725顏色/光傳感器（Adafruit）。注意，你必須調用setup()在讀值之前

tls

TLS模塊依賴于 net 模塊，它是一個必需的依賴項。
nodemcu包括MBED TLS庫的開源版本。與nodemcu默認配置支持TLS 1 / 1.1 / 1.2和最常見的密碼套件，包括DH / ECDH。ECDSA的加密套件，默認是關閉的。

tm1829

tm1829是庫處理LED燈條使用泰坦的微 tm1829 LED控制器。圖書館使用任何GPIO流LED控制命令。

tmr

tmr模塊允許訪問簡單計時器、系統計數器和正常運行時間。它的目的是建立定期發生的任務，定時操作，并提供低分辨率三角洲。然而，tmr模塊不是時間保持模塊。雖然大多數超時毫秒甚至微秒表示，精度有限，復合誤差會導致相當不準確的時間記錄。考慮使用rtctime模塊“掛鐘”時間。nodemcu提供7的靜態定時器，編號為0-6，動態定時器產生功能create() 。

tsl2561

tsl2561是光-數字轉換器，它將光強轉換成數字信號輸出，具有直接I2C接口或者SMBus接口。每個設備都連接一個帶寬的光敏二極管和在單獨CMOS集成電路上的一個紅外響應的光敏二極管，這個集成電路具有提供20bit動態范圍的近-適光響應的能力。兩個集成的ADCs將光敏電流轉換成一個數字輸出，這個數字輸出表示測量每一個通道的發光。這個數字輸出可以是一個微處理器的輸入。

u8g

u8glib是一個圖形庫在olikraus / u8glib與許多不同的顯示器支持開發。的nodemcu固件支持這些子集。

uart

UART（通用異步接收器/發送器）模塊允許在UART串行端口上配置和通信。UART的默認設置是通過構建時間設置來控制的。默認利率是115200個基點。此外，自動波特率檢測是前兩分鐘后平臺啟動。當接收到幾個字符時，這將導致切換到正確的波特率。自動波特率檢測時禁用uart.setup叫做。

ucg

ucglib是一個圖形庫在olikraus / ucglib與彩色TFT顯示支持開發。的nodemcu固件支持這些子集

websocket

一個WebSocket客戶端模塊實現rfc6455（版本13），提供了一個簡單的接口發送和接收消息。實施支持零散的信息，自動響應ping請求和定期坪如果服務器沒有溝通。
SSL / TLS支持
注意在 net 模塊中記錄的約束。

wifi

WiFi子系統由定期運行的后臺任務來維護。任何功能或任務，需要更長的時間比15ms（毫秒）可能導致無線子系統的崩潰。為了避免這些潛在的崩潰，建議無線子系統將暫停與WiFi。suspend()之前任何任務或功能，超過這個15ms指南的執行。

wps

WPS允許在不輸入網絡憑據的情況下將設備添加到現有網絡中。

ws2801

ws2801燈帶

ws2812

WS2812是庫處理WS2812像LED燈條。它至少在WS2812，ws2812b，apa104，sk6812（RGB或RGBW）。
此庫使用UART1路由gpio2（引腳D4在nodemcu devkit）產生的比特流。它可以使用UART0發送到txd0以及同時處理兩LED燈條。
警告：在雙模式，你將失去進入Lua控制臺通過串口（它將被重新配置支持WS2812協議）。如果你想保持訪問Lua控制臺，你可以使用另一個輸入通道就像一個TCP服務器（見例子）

xpt2046

XPT2046是觸摸控制器使用的一些便宜的顯示器經常與ILI9341顯示控制器組合。該模塊是基于spapadim和paulstoffregen庫的建立。