Directorio de artículos
0 Prefacio
Antes configuré el entorno de Arduino en la computadora basado en VS Code, el método general es descargar un complemento en VS Code y configurar la ruta de Arduino IDE bajo la premisa de instalar Arduino IDE, en general es muy simple . Pero hoy, al configurar según el método en la memoria, apareció una ventana emergente:
Después de prueba y error, descubrí que si desea configurar en función del IDE de Arduino como antes, solo puede ignorar esta configuración y no puede hacer clic en "Usar arduino-cli incluido", de lo contrario, se producirán problemas.
Originalmente, este problema estaba casi resuelto, pero lo abominable es que esta ventana emergente aparecerá cada vez que se actualice la ventana, lo cual es muy molesto. Así que tomó un poco de tiempo leer cuidadosamente toda la información relevante sobre arduino-cli, ¡y me sorprendió descubrir que este arduino-cli es increíble! Basta con configurar el entorno de desarrollo, ¡y no depende en absoluto del IDE de Arduino! , este tutorial presenta brevemente cómo configurar el entorno de desarrollo del marco Arduino basado en arduino-cli en VS Code .
También hay algunos tutoriales similares en Internet, pero no son lo suficientemente detallados y claros. Partiendo del principio, aquí hay un tutorial más detallado, con más contenido, por favor mírelo con paciencia.
1 Ventajas de VS Code y desventajas de Arduino IDE
Si está utilizando el IDE de Arduino, solo necesita descargarlo del sitio web oficial y luego instalarlo sin pensar, es muy simple. Pero usar VS Code requiere una configuración relativamente problemática. Pero el trabajo duro siempre da sus frutos. Aquí hay una breve charla sobre las ventajas de VS Code y las desventajas de Arduino IDE.
Mire los beneficios antes de decidir si gastar tiempo.
- La interfaz de VS Code es mejor que el IDE de Arduino, de eso no hay duda
- VS Code puede rastrear el código fuente, lo cual es mucho más conveniente para comprender bibliotecas de terceros
- El aviso inteligente de VS Code (IntelliSence) reduce en gran medida la carga de trabajo del código de código
2 Preparación preliminar
- Tener VSCode y comprender su principio de funcionamiento básico, y básicamente puede usarlo
- No es necesario descargar el IDE de Arduino, si se descarga, se puede desinstalar por completo.
3 CLI de Arduino
3.1 ¿Qué es la CLI de Arduino?
En primer lugar, comprendamos qué es este cli. El llamado cli , es decir, interfaz de línea de comandos , es opuesto a gui (interfaz gráfica de usuario), es decir, usar la línea de comandos para realizar las funciones que se pueden completar haciendo clic en el botón de la interfaz gráfica. Es una herramienta integrada lanzada oficialmente en 2018. Integra el proceso de desarrollo integrado relacionado con Arduino, como compilación y descarga, biblioteca de administración y SDK de placa, etc. en esta herramienta. ( Por supuesto, no tiene la función de compilar y descargar, solo llama a otras herramientas para operar ) De esta manera, solo esta herramienta puede usarse para construir todo el proyecto, que es muy poderosa.
Y esta herramienta es multiplataforma y se puede integrar fácilmente en varios editores populares, como VS Code y Eclipse, etc.
Aquellos que estén interesados pueden mirar la introducción dada en el sitio web oficial.
3.2 Descarga e Instalación
La herramienta cli de Arduino se actualiza muy rápidamente, básicamente cada pocos días, por lo que se recomienda descargarla desde el GitHub oficial: https://github.com/arduino/arduino-cli/releases
Arduino cli es un único archivo ejecutable que puede descargarse como un paquete comprimido y colocarse en algún lugar de su computadora. Sin embargo, se recomienda descargar el archivo con el sufijo de para que la ruta de instalación se agregue automáticamente a la variable de entorno.msi durante la instalación , lo que es menos problemático.
Después de la instalación, compruebe si la instalación se ha realizado correctamente:
arduino-cli -h #or --help
Si no hay errores, la instalación es exitosa.
El rojo subrayado en la imagen de arriba son instrucciones más importantes, que se utilizarán más adelante.
3.3 Uso básico
Aquí hay dos técnicas de uso simple.
-
Consulte rápidamente las instrucciones de ayuda
Si no sabe qué "subcomandos" hay detrás de un determinado comando, puede usar--helpo-hpara consultar el uso del comando. O no ingrese ningún parámetro directamente, y el documento de ayuda se abre de forma predeterminada. Si lo ingresa directamente,arduino-clitambién abrirá el documento de ayuda -
Configuración de finalización de pestañas
Esta es una operación de finalización de pestañas proporcionada por el funcionario, que puede admitir la finalización de todos los comandos y parámetros, lo que es más conveniente al ingresar comandos. La premisa parece ser instalar Power Shell7. Para obtener tutoriales de configuración específicos, consulte el sitio web oficial Puedes omitirlo si no quieres molestarte.
3.4 Configuración del entorno de desarrollo
Como se mencionó anteriormente, arduino-cli es una herramienta integrada, que básicamente incluye las funciones comunes de Arduino IDE, e incluso puede considerarse como el núcleo de Arduino IDE, pero carece de un editor. Por lo tanto, es mejor comprender las funciones básicas del IDE de Arduino para que pueda comprender casi todos los pasos de la configuración.
Antes de configurar, primero debe saber qué directorios tiene el IDE de Arduino.
- El primero es el directorio de instalación del IDE, que se encuentra
%ProgramFiles(X86)%\Arduino_1.8.19bajo el directorio (ruta predeterminada) - Luego está el directorio SDK de la placa de desarrollo. Cada placa de desarrollo tiene su código básico correspondiente, biblioteca integrada, herramientas de compilación y descarga, etc. Estos archivos se colocan en la
%LocalAppdata%\Arduino15carpeta - Si se instala una biblioteca de terceros durante el uso, el archivo de la biblioteca se colocará en la carpeta del proyecto . Por supuesto, esto también se puede personalizar en el IDE:
Después de comprender la estructura de carpetas de Arduino IDE, debe tener una cierta comprensión de su principio de funcionamiento y luego comenzar a usar el arduino-cli instalado para construir el entorno de desarrollo de Arduino.
La parte del código VS está en la parte posterior. Esta parte puede ser un poco difícil de entender, pero no se asuste, solo sígala y puede entenderla después de terminarla.
- Configuracion inicial
arduino-cli config init --dest-dir "$env:LOCALAPPDATA\Arduino15"
El motivo de elegir esta carpeta es que el complemento Arduino en VS Code solo reconoce los archivos de configuración en esta carpeta, lo cual se entenderá más adelante.
Si desea ver la configuración, puede:
arduino-cli config dump
Esto es esencialmente mirar el archivo de configuración inicial anterior. Si no hay un archivo de configuración en la ruta predeterminada, se muestra la configuración predeterminada integrada.
- Modificar el archivo de configuración (Opcional)
Al verificar la configuración predeterminada, podemos ver que el archivo de la biblioteca y el archivo SDK de la placa no están en la misma ruta, lo cual es muy inconveniente para mí personalmente, así que modifique la configuración:
arduino-cli config set directories.user "$env:LOCALAPPDATA\Arduino15"
De esta manera, los archivos de configuración, los archivos SDK de la placa y los archivos de biblioteca de terceros instalados están todos en una ruta. Si necesita encontrar el objetivo, será más claro.
- Descarga el núcleo de la placa de desarrollo
Ese es el SDK mencionado repetidamente anteriormente, las diferentes placas son diferentes, si solo desarrolla Arduino, solo necesita instalar el kit de desarrollo de Arduino:
# 先更新一下板子列表（core list）
arduino-cli core update-index
# 再下载arduino核心（SDK）
arduino-cli core install arduino:avr
Entonces, ¿qué pasa si quiero desarrollar ESP8266 y ESP32? ¿Recuerdas cómo se configuró en el IDE de Arduino? Primero agregue un enlace de placa, un archivo json y luego descargue e instale, y luego la lista de placas tendrá muchos modelos de placas de desarrollo opcionales.
Creo que cualquiera que lo haya configurado sabe que la probabilidad de falla es muy alta cuando se configura en el IDE de Arduino, y muchas veces se necesitan varios clics para descargar.
Entonces, el enfoque aquí es el archivo json de los paquetes. De los tutoriales anteriores, este enlace siempre fallará, por lo que se recomienda encontrar un enlace de GitHub relativamente fijo:
Instrucciones de instalación:
# 先添加额外的链接，按需选择，多个开发板用空格分隔
arduino-cli config set board_manager.additional_urls https://hub.yzuu.cf/esp8266/Arduino/releases/download/3.1.2/package_esp8266com_index.json https://hub.yzuu.cf/espressif/arduino-esp32/releases/download/2.0.7/package_esp32_index.json
# 然后再更新一下链接（实际上就是把上面两个文件下载下来）
arduino-cli core update-index
# 这个时候就可以根据需要下载对应的开发板包了
arduino-cli core install esp32:esp32
arduino-cli core install esp8266:esp8266
En el tercer paso, si la velocidad de descarga es demasiado lenta, es porque cada paquete de descarga se descarga desde GitHub, se recomienda modificar el archivo de paquetes y usar el sitio web espejo para descargar, la velocidad será mucho más rápida:
Se recomienda usar buscar y reemplazar, github.comreemplazar todo con hub.yzuu.cfy luego ejecutar el comando anterior
Una vez completada la instalación, puede usar arduino-cli para borrar el archivo de caché
# 加上-v可以看到详细输出信息
arduino-cli cache clean -v
Hasta aquí la parte arduino-cli está configurada, luego veamos como configurar la parte VS Code
4 Configuración de código VS
- Primero instale el complemento Arduino, no hay duda al respecto
Mi sugerencia es echar un vistazo más de cerca al módulo "Detalles", para que pueda tener una mejor comprensión de las operaciones posteriores. Este complemento tiene dos dependencias, a saber, el complemento C/C++ y un complemento de puerto serie, que deben instalarse automáticamente durante la instalación.
Después de instalar el complemento, si observa el directorio de instalación de este complemento, encontrará que se ha descargado una CLI de Arduino de forma predeterminada en el directorio (es decir, la CLI de Arduino que instalamos anteriormente, tal vez solo la versión es diferente), y las funciones de compilación y descarga del complemento dependen de la implementación de este programa.
Teóricamente, ya existe un programa de ejecución, por lo que no es necesario que lo instales tú mismo, pero personalmente siento que aún debes instalarlo de nuevo. Hay dos razones principales:
- ①El archivo en sí no es demasiado grande, <30M, por lo que descargarlo/copiarlo parece menos costoso;
- ②Para usar este programa en cualquier ubicación, es mejor agregarlo a la variable de entorno, pero dado que el complemento de VS Code cambiará el directorio cuando se actualice, generalmente cambia con el tiempo, por lo que agregarlo al entorno variable no es significativa.
- Configuración del complemento
La configuración de este complemento es muy simple, simplemente marque la opción Usar Arduino Cli
- uso básico
Si se instaló el SDK de la placa de desarrollo, cree un nuevo archivo en VS Code .inoy luego seleccione la placa de desarrollo en la barra de estado inferior, el programa se actualizará automáticamente y creará un archivo en la carpeta del proyecto actual c_cpp_properties.json, que establece el correspondiente desarrollo de la placa de desarrollo El compilador que debe usarse en el proceso, los archivos de la biblioteca que deben incluirse, etc. Si no aparece, puede probar Ctrl Shift P, elegir recargar la ventana y actualizar varias veces. Y si cambia la placa de desarrollo, se actualizará automáticamente. Este es el papel importante de VS Code, es decir, lo ayuda a ahorrar mucho trabajo y no necesita escribir comandos usted mismo, lo cual es muy conveniente .
- Agregar archivos de biblioteca
¿Qué sucede si desea agregar una biblioteca de terceros y usarla en el programa durante el proceso de desarrollo del programa? Primero, instale la biblioteca de terceros usando la línea de comando:
# 查看已安装的库
arduino-cli lib list
# 搜索某个库
arduino-cli lib search <name>
# 安装某个库
arduino-cli lib install <name>
# 升级
arduino-cli lib upgrade
Después de instalar la biblioteca de terceros, se puede hacer referencia directamente en el programa, pero generalmente se dibujará una línea ondulada. Esto se debe a que el archivo c_cpp_properties.json no se ha actualizado. Intente volver a cargar la ventana. Está casi bien, porque cada vez que se vuelve a cargar la ventana, el complemento verificará el archivo ino abierto (Verificar)
-
Precauciones de uso
- Preste siempre atención a la barra de estado en la esquina inferior derecha, es decir, el modelo de placa, el número de puerto serie, el archivo de destino (no necesariamente el archivo abierto), etc.
- arduino-cli todavía usa el concepto de archivos de proyecto Arduino IDE, por lo que cada vez que cree un nuevo archivo, recuerde establecer una carpeta con el mismo nombre fuera
En resumen, el complemento Arduino en realidad se basa en el programa cli en el directorio de instalación e integra algunas de sus funciones comunes en algunos botones en la interfaz de VS Code, lo que facilita enormemente el uso de los desarrolladores.Antes de descargar e instalar arduino -cli , más para necesidades ocasionales, como cuando se instala una biblioteca de terceros, pero la operación real sigue siendo el programa arduino-cli que viene con VS Code. Es equivalente a dos programas idénticos leyendo y escribiendo la misma pila de archivos.