Spresense Arduino Library 开发指南

Spresense 主板上装载有４个内置LED。APP可以自由使用。LED定义为 LED0 到 LED3。这些LED可以通过 pinMode() (仅限OUTPUT)、digitalWrite() 进行操作，通过 ledOn() 或 ledOff() 这样的专用API也同样可以操作。LED_BUILTIN 在Spresense Arduino Library中对应分配为LED0。

Spresense 虽然没有内置EEPROM，但可以通过Flash内存模拟EEPROM。处理永久性数据时可以使用EEPROM程序库或是Spresense扩展板的SD卡。

Spresense 上配备有2个串行端口(UART)、支持Serial 。主板上的USB端口可以通过将其定义为 Serial 用于调试串口来使用。另一方面，D00和D01引脚可以用作 Serial2 。

像Serial.begin(115200，SERIAL_8E1)这样，使用第二个参数设置数据长度，奇偶校验有无以及停止位。 如果省略该参数，则默认值为“ SERIAL_8N1”，数据长度为8位，无奇偶校验和1个停止位。

还有，`Serial2`支持硬件流程控制。 像Serial2.begin(115200，SERIAL_8N1 | SERIAL_RTSCTS)这样，添加“ SERIAL_RTSCTS”使硬件流程控制有效。 如果省略该参数，则默认情况下硬件流程控制无效。

警告：即使禁用了硬件流控制，“ UART2_RTS”，“ UART2_CTS”引脚也不能用于GPIO等其他用途。

关于pinMode(pin, mode) 的模式, INPUT , OUTPUT, INPUT_PULLUP, INPUT_PULLDOWN 都是支持的。关于I/O电压，主板侧的数字端子为1.8V，但扩展板的数字端子设计为3.3V或5V输出（通过跳线JP1选择）。由于这种电平转换是通过电平转换器和上拉电阻完成的，因此扩展板的数字端子有一些限制。

有关电平转换器和上拉电阻的详细信息、请参考Spresense扩展板电路图。

Spresense 配有从A0到A5的 6个模拟输入专用Pin接口。这些Pin接口不可以用做数字Pin接口。 analogRead() 中指定的Pin接口定义为如 A0 、 A1 、 A2 、 A3 、 A4 、 A5 ，而不仅仅是使用Pin接口编号的数字。

Spresense 扩展板的模拟输入参考电压固定为5V，主板的模拟输入参考电压固定为0.7V。 analogReference() 是不支持的。

analogWrite(pin, value) 输出一个周期约为490Hz的PWM信号。当指定的 pin 号为3,5,6,9时，PWM信号由硬件输出。如果指定了其他 pin ，则通过软件控制，使用定时器交替输出High/Low信号来生成PWM信号。

tone(pin, frequency [, duration]) 是使用定时器通过软件控制来生成音调信号。此时，由于定时器的分辨率为1微秒，当频率的半周期不能整除1微秒时会发生频率误差。 可设置的最大频率约为166kHz。 tone() 函数与 attachTimerInterrupt() 函数使用的是相同的计时器资源，所以不能与 attachTimerInterrupt() 同时使用。

不支持宏 F() 。虽然可以使用 F() 宏进行编译，但是它只是像普通字符串数据一样放在RAM上。（F()示例： Serial.println(F("This string will be stored in flash memory")); )

PROGMEM 是不支持的。 PROGMEM被定义为空宏，即使被使用，也不会出现编译错误。

Pin接口的中断编号由attachInterrupt()函数动态分配。 digitalPinToInterrupt() 定义为空的宏函数，使用方式如下，可任选其一。

attachInterrupt(digitalPinToInterrupt(pin), void (*isr)(void), mode);
attachInterrupt(pin, void (*isr)(void), mode);

pin: D05等Pin接口编号

isr: 发生中断时调用的函数。本函数既无参数也没有返回值。

mode:中断触发模式

支持定时器(timer)中断功能。 本功能与tone()使用同一计时资源，所以不能和tone()同时使用。

attachTimerInterrupt()在系统中只能有一个在使用。如果在已使用时再次调用attachTimerInterrupt()，则会发生错误。再次设置不同的处理程序前，请先调用detachTimerInterrupt()以释放资源，然后再次调用attachTimerInterrupt()。

void attachTimerInterrupt(unsigned int (*isr)(void), unsigned int us);

isr: 发生定时器(timer)中断时调用的函数。本函数返回下一计时周期作为返回值。

us: 微秒

micros()在RTC (32.768kHz)周期内计时，所以可精确到约30微秒。

运行Audio程序库前需要事先准备的物品如下所示：

Spresense 扩展板带有Mic输入专用Pin接口、SD卡槽、耳机插孔。耳机插孔为3极3.5mm立体声插孔。

Pin接口配置与音频相关接口等详细内容请参考： Mic的使用方法、扬声器的使用方法。

使用了Audio程序库的Sketch样例程序可在Arduino IDE中的 文件 → 程序样例 → Spresense用Sketch程序样例 Audio → application下找到。运行Audio相关的样例Sketch程序时，需要事先准备好DSP codec二进制文件。

执行音频的播放&录制功能时，需要按下面的步骤安装DSP二进制文件。

DSP二进制文件可选择安装到SD卡或是闪存中。安装方法可以通过PC简单地将文件复制到SD卡中，也可以使用DSP安装程序完成安装。

更多信息请参见以下链接。

以下是Camera库的示意图。

Spresense Camera提供两个库类。 一个是CameraClass类的实例“theCamera"，另一个是CamImage类，负责处理从Camera获取的图像。

"theCamera"有三个主要功能。

CamImage 类是用户操作从theCamera获取的图像图像的函数。 下图显示了CamImage类的概述。

CamImage 类有两个功能。

以下是theCamera和CamImage的这五个功能。

通常，Camera取景器会显示摄像机上实时图像。 在这里，此实时图像（实时视频）称为预览图像。 "theCamera"具有获取此预览图像每帧的功能。

若要获取预览图像，首先使用begin()方法函数确定预览图像的图像格式。 begin()方法函数的定义如下所示：

提供给begin()的所有参数都确定预览图像的参数。 每个theCamera内具有预览图像缓冲区数和视频帧速率（每秒获取多少帧图像）， 图像的大小和图像数据的像素格式。 默认情况下，每个内部图像缓冲区数为30FPS（每秒30个）、图像大小为QVGA（320x240）和YUV422像素格式。 如果内部图像缓冲区的数量是默认的，请使用默认值。

增加内部图像缓冲区数的一个示例是当要处理大量图像（如处理各种图像）时，可以将图像处理与Camera图像检索并行化。 在这种情况下，内部图像缓冲区数为2，允许并行从Camera获取图像，同时执行繁重的处理，从而改善帧速率。 但是，QVGA会消耗大约150KB的缓冲区内存。因此，如果需要设置更多内存，请小心。

begin()方法函数是使用theCamera时必须首先调用的函数。 当begin()方法函数成功完成后，使用startStreaming()方法函数注册回调函数以获取预览图像。 回调函数的类型如下所示：

用户实现自己的类型函数，并使用startStreaming()方法函数进行注册。 如果启动Streaming()的第一个参数为"true"，则每次检索图像时，将开始检索预览的视频图像，并调用已注册的回调函数。 获取图像的频率由begin()方法函数中指定的帧速率决定。 但是，除非用户实现的回调函数结束，否则不会调用下一帧的回调函数。 如果要停止获取预览图像，请将startStreaming()方法函数的第一个参数设置为false并调用startStreaming()方法函数。

在普通的Camera中，可以设置各种参数，如调整颜色、亮度和 Spresense Camera， 也可以进行一些设置。

在调用begin()方法函数后，可以在任意时间调用这些设置方法函数。

预览图像的分辨率较低，但以视频帧速率的频率获取图像。 另一方面，如果将数据作为照片检索， Spresense Camera可以获取高分辨率JPEG压缩图像。

首先，对theCamera执行"设置胶片"的过程。 执行此操作的方法函数是setStillPictureImageFormat()。 使用此方法函数设置静止图像（照片）的图片大小和像素格式。

第一个和第二个参数指定图像的垂直和水平大小。第三个参数指定图像的像素格式。

设置完图像后，可以随时执行"关闭快门"过程以获取照片数据。 为此，方法函数是takePicture()。 takePicture()返回CamImage实例作为返回值。 如果照片拍摄中出现任何错误，则返回空的CamImage。 要确定CamImage实例是否为空，可以使用CamImage类的isAvailable()检查它。

在startStreaming()中回调和takePicture()返回值的CamImage实例包含检索到的图像信息。 可以使用CamImage类的方法函数来获取有关图像的信息。

CamImage实例提供单个图像转换方法函数。

如果要将图像显示到显示器，则显示器的像素格式通常采用 RGB 格式。 特别是，如果有一个预览图像，在很多情况下，想显示获得的图像。 在这种情况下，可以使用此方法函数转换像素格式。

convertPixFormat()在数据内存中转换像素格式，因此当前CamImage实例将被覆盖。

实际上，使用 Spresense Arduino 包中的Camera示例代码，将说明如何使用 Spresense Camera。

从Arduino IDE菜单栏打开示例代码。

"File" ⇒ "Sketch example" ⇒ "Camera in Spresense sketch example" ⇒ "camera"

此示例将预览图像设置QVGA，帧速率为60FPS，获取60帧数据时拍摄单个JPEG 照片，并将其存储在SDCard上。

当建立完成之后，请继续完成这些步骤：“initial setting"，”setup()“，“preview callback”和“loop()”。

因此，请仔细查看这四个。

通过 image_recognition.MNIST.LeNet 或者 LeNet.sdcproj 所学习后的网络模型，可以对一个28x28大小的输入图片输出10个数字的排列结果。这其中的10个排列数据是对图片识别后的数字结果的表示。在这个10个排列中，也会输出对每个数字的识别确信度。例如，排列中第一个（index 0）就是表示所输入图片中的数字是「0」的确信度。

number_recognition.ino 会将确信度最高的index作为识别数字，将其与确信度一起输出。

可以通过 number_recognition.ino 中下面的部分来修改所要输入的图片。

eMMC程序库是用于访问eMMC外接板设备的库。

eMMC程序库 Arduino SD程序库 与API配置类似，将对象名称从"SD"替换为"eMMC"，您可以使用与SD库相同的接口访问eMMC设备。

这个库还支持USB MSC(Mass Storage Class)功能作为附加功能。 连接 Spresense 扩展板上的USB和PC，通过调用"beginUsbmsc()"函数，您可以直接从电脑在eMMC设备上访问文件。

有关各种API的详细信息，请参阅 eMMC Library API API参考手册。

eMMC程序库提供4个简单示例。

File程序库是一个常用库。 File对象由 SDHCI 、Flash 、 eMMC 库中的open()函数生成的。 这个库提供了对打开的文件对象执行文件操作的功能。

有关各种API的详细信息，请参阅 File Library API API用户手册。

当文件实例名称为myFile时，程序会按下面代码打开:

为 File 对象提供了以下函数:

File库提供以下示例：

Flash程序库是用于访问 Spresense 主板上的闪存设备的库。

Flash程序库 Arduino SD程序库 与API配置类似，通过将对象名称从"SD"替换为"Flash"，您可以使用与SD库相同的接口访问Flash设备。

有关各种API的详细信息，请参阅 Flash Library API API参考手册。

Flash程序库提供了两个简单示例。

更多信息请参见： Spresense SDK GNSS documentation。

clockMode() 的参数 CLOCK_MODE_156MHz 、 CLOCK_MODE_32MHz 、 CLOCK_MODE_8MHz 指定一个动态切换应用程序 CPU 的时钟和整个系统的时钟。降低工作时钟可以降低功耗。

作为参考，三种模式表示电池边缘的电流消耗。 测量条件仅使用Spresense主板，电源由电池连接器提供3.7V。 软件处于空闲状态是在什么都不工作的情况下。

此测量还包括主板上的电源LED的电流消耗。

除了用户应用程序的时钟模式控制外，还可以在系统内自动切换时钟模式。

请注意, 这不一定会将用户更改为指定的时钟模式。 当前时钟模式可以通过 getClockMode() 功能获得，以确定时钟模式是否已切换。

此外，并非所有功能都在低时钟模式下工作。以下是限制:

有关LowPower程序库的基本用法, 请参阅示例中的说明。 示例sketch 可以从Arduino IDE 菜单 File → Examples → Examples for Spresense LowPower 打开。

MultiCore MP程序库（以下简称MP程序库）是一个库，用于支持Arduino环境中的多核编程。默认情况下调用的CPU内核称为 MainCore 和 SubCore ，后者从 MainCore 调用。从 SubCore 1 到 SubCore 5 ，总共有5个 SubCore 。

在 Tools→ core 的Arduino IDE 菜单中选择 MainCore 、 SubCore 1-5 。程序在每个内核加载和移动每个核心编译的二进制文件到Spresense主板。MP程序库可用于与每个核心项目合作。

MP程序库主要提供以下功能。

有关API详细信息，请参阅 MP Library API 文档。

有关MP库的基本用法，请参阅示例中的示例。 示例是Arduino IDE菜单 File → Examples → Examples for Spresense → MultiCore MP 。

SDHCI程序库用于访问Spresense扩展板上的microSD卡。

SDHCI程序库与Arduino SD程序库类似，为API结构。可以从应用了SD程序库的既存Sketch程序中简单移植过来。

与使用SPI接口的SD程序库不同，它需要使用SD Host Controller Interface专用硬件来访问SD卡。其特点如下：

这个程序库也提供USB MSC(Mass Storage Class)功能。通过连接Spresense扩展板上的USB和PC，您可以直接从电脑访问SD卡上的文件。

有关各种API的详细信息，请参阅 SD card Library API API参考手册。

由于尚未在SDHCI库中,生成SDHCI实例，可按照下面代码进行定义：

SDHCI 库提供三个示例草图。在FAT32格式下，使用SD卡。

首先，Sensor Framework显示在 Spresense 中。

请参阅 传感器融合框架 文档。

下面显示Arduino的传感库的体系结构。

由 Spresense SDK 提供的Sensor Framework部分是作为"Sensing"库提供的，以实现与SDK相同的功能。
如果您正在使用Arduino(传感器的驱动程序)、使用传感器的应用程序以及用自己创建更抽象的逻辑传感器进行开发，请通过实现逻辑传感器的信号处理部分，您可以使用复杂的逻辑传感器创建应用程序。

下面是每个类的API说明。

样例程序请参考SPI_loopback.ino。运行此样例时，请在电路板外侧将MOSI与 MISO以回环方式连接。可通过自行接收发送的数据来确认数据的收发处理。

Storage程序库是各类存储库（如SDHCI、SPI-Flash、eMMC）的基类。 基本上，每个存储设备将通过库 SDHCI、 Flash、 eMMC 使用， 但还可以通过指定包含挂载目录的绝对路徑使用。

各种存储和装载目录名称之间的关系参考如下。

有关各种API的详细信息，请参阅 Storage Library API API参考手册。

Storage程序库提供一个简单示例。

按照以下步骤使用此库，也可以使用 Watchdog 作为 WatchdogClass 的实例。

如果要检查触发硬件复位的剩余时间，可以使用 Watchdog.timeleft() 。

该库的示例位于Arduino IDE上的 File> Sketch example> Watchdog> Watchdog_bite 中。

通信速度定义如下。启动时可从以下3种中选择。

默认通信速度为100kHz 。

程序库支持以下2种I2C地址长度：

默认的地址长度为7 bit。

与原始的Arduino Wire程序库一样，Spresense Wire 程序库也配备了32 byte大小的buffer。因此，与设备间的通信数据需要控制在此范围内。数据中超出此范围的部分将被丢弃。