构建一个激励语录查看器

M5Stack PaperS3是创建能够显示来自各种类型传感器数据的信息面板的绝佳选择。但它也可以可视化从互联网上的多个来源提取的内容，如天气信息和预报，股票价格，新闻，和许多其他有用的(有时只是有趣的)数据。

为了访问这类内容，许多服务提供了所谓的api——一个允许我们与网站“对话”以发送或接收结构化数据的接口。

在本文中，我将解释什么是API，如何使用API，并作为一个实际示例，我们将构建一个激励语录查看器，它每隔15分钟自动下载鼓舞人心的语录，并将它们显示在PaperS3屏幕上。

如果您不熟悉PaperS3的特性，我建议您查看之前的这篇文章，在这篇文章中我做了全面的回顾，并展示了一个简单的示例。

什么是API?

作为用户，我们使用浏览器及其界面访问网站及其服务。但是在计算机或微控制器上运行的应用程序需要其他机制来交换数据。这就是api(应用程序编程接口)发挥作用的地方：它们定义了一组规则，允许另一个应用程序或服务(不是人)访问网站并请求数据或执行功能。

RESTful API

api可以通过多种方式实现。在web API的情况下，最常见的方法是通过HTTP协议使用GET或POST等方法。它们通常遵循一种称为REST(具象状态传输)的方法，这就是为什么它们被称为RESTful api(或简称REST api)的原因。

REST API的主要特性包括：

•使用HTTP协议：web浏览器使用的HTTP协议。

•遵循客户机-服务器模型：客户机发出请求，服务器响应。

•通过URL访问资源：每个资源都有自己的地址，称为端点。

•使用标准HTTP方法：GET、POST、PUT、DELETE。

•独立处理每个请求：请求之间不存储上下文(这称为无状态)。

•服务器用状态码(例如，200 = OK)和可选的JSON等标准格式的数据进行应答。

API的例子

如前所述，许多网站都可以通过REST api访问。有些是付费的，有些是免费的，但需要注册才能获得访问令牌或密钥，还有一些是完全开放的。例子包括:

•OpenWeather：天气数据

•Todoist：访问任务和项目

•格言：励志名言

•Cat API：随机猫图像

•股票数据：财务信息

•ChuckNorris。有趣的查克·诺里斯故事

接下来，我将向您展示如何为M5Stack PaperS3创建一个应用程序，该应用程序可以使用ZenQuotes API全天下载激励语录。该过程非常通用，因此您也可以轻松地将其应用于其他基于REST api的网站。

ZenQuotes

ZenQuotes是一个提供免费服务的网站，可以通过其API从各种作者和主题中获取励志名言。

基本功能是完全免费的，不需要注册或令牌。但是，对于高级功能或大量使用，需要付费帐户。

端点

其中mode可以为：

•random：返回一个随机引号

•quotes：返回多个引号(非常适合缓存和本地显示)

•today：返回当天的特色报价

•author：根据作者筛选引用(与其他模式一起使用);溢价)

•image：返回一张图片(仅限高级版)

响应格式

对API的任何请求都以JSON格式返回数据，其中包含以下关键字：

•q =引用文本

•a =作者姓名

•i =作者形象(仅限收费)

•c =引用的字符数

•h =引用HTML格式

响应是这种格式的元素数组。当调用/quotes时，响应包含多个项目。在/random或/today这样的端点中，它只包含一个。

来自/today端点的示例响应：

请求和响应处理可以在Arduino或MicroPython中轻松编码，但对于这个项目，我将使用UIFlow 2，使其更加可视化和初学者友好。

这个项目

该程序的结构很简单，由以下任务组成：

•初始化设备

•连接Wi - Fi网络

•向ZenQuotes网站提出请求

•在屏幕上显示引用及其作者

•15分钟后，将设备下电并重启

最复杂的部分是在屏幕上显示文本的功能，因为我设计它是为了保持单词分隔，避免单词在中间划线。我将一步一步解释它是如何工作的。

初始化

在初始化期间(除了UIFlow执行的默认设置之外)，使用覆盖整个显示器的图像小部件设置屏幕背景。

使用Web终端将图像(名为FondoEPD16p.png的文件)上传到PaperS3的闪存中，然后使用代码中的Set image0 Show块使其可见。

接下来，设置字体大小、文本颜色和背景颜色。在坐标20,80处也为即将打印的文本定义了光标位置。

连接Wi - Fi

Wi - Fi连接是通过调用ConnectWifi函数建立的，该函数使用以下代码块定义：

此功能将Wi - Fi设置为STA(站)模式，并连接到您的家庭网络。记住用实际的网络详细信息替换隐藏的SSID和密码。该函数返回连接状态，允许您验证连接是否成功。

发送请求到ZenQuotes

如果Wi - Fi网络连接失败，则会显示错误信息。如果成功，则向ZenQuotes网站发送请求。

在屏幕显示文本

在程序的这一部分中，将处理服务器响应。如果没有错误，则使用PrintLargeText函数将引用和作者显示在屏幕上。

如上图所示，第一步是检查来自服务器的响应代码是否为200(这意味着一切正常)。如果不是200，则显示一条错误消息。如果是，则解析接收到的信息。

首先，服务器返回的JSON数据存储在变量ResponseData中。

接下来，使用get键块，我们在ResponseData的元素0(一个列表，尽管它只包含一个元素)中查找键q，它对应于引号。该键的值存储在变量Text中，并作为参数传递给PrintLargeText函数，该函数将其显示在屏幕上。

重复相同的过程来查找与作者姓名对应的键a。该值再次存储在Text中，并使用PrintLargeText打印。

现在让我们看看这个函数是做什么的：

这个想法是打印引用的完整单词，而不会在屏幕边缘破坏它们。

要做到这一点，要打印的文本被分割成一个称为单词的单词列表。然后，使用count循环逐个打印这些单词，同时确保字符总数加上空格不超过20个——这是我设置的最大宽度。如果下一个单词将超过这个限制，则从更低的位置开始新的一行，并重复此过程，直到打印所有单词。

设备下电

为了节省电池，在显示文本后，程序暂停2秒，然后关闭PaperS3电源，并计划在15分钟内唤醒它。

上面的所有操作都是在Setup块中完成的，Loop块中没有任何操作。

这是PaperS3的样子，上面有鼓舞人心的名言，用内置的磁铁贴在我的冰箱上

结论

M5Stack PaperS3不仅因其低功耗EPD屏幕而脱颖而出，而且还因其成为数字世界窗口的能力而脱颖而出——显示有用的、有趣的或仅仅是鼓舞人心的信息。

在这个项目中，我们学习了如何使用REST API连接到像ZenQuotes这样的web服务，检索JSON格式的内容，并在屏幕上清晰地显示出来。我们使用UIFlow 2完成了所有这些，这表明您不需要编写太多代码来创建连接和视觉上引人入胜的应用程序。

除了这个励志语录的例子，同样的结构可以很容易地适应显示：

•每天的天气，

•待办事项清单，

•财务数据,

•新闻标题

•或任何其他可通过API访问的数据。

与UIFlow 2编程环境相结合，PaperS3以简单直观的方式成为进入物联网和网络连接编程世界的绝佳工具。它的易用性使其成为教育项目的理想选择-其目标是学习api，传感器和自动化-以及家庭制造项目，如信息面板，日常计划或数字板，为您的家庭带来功能和风格。

本文编译自hackster.io