• Stars
    star
    136
  • Rank 267,670 (Top 6 %)
  • Language
    Go
  • License
    GNU Affero Genera...
  • Created about 5 years ago
  • Updated 27 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

An Arduino Language Server based on Clangd to Arduino code autocompletion

Arduino Language Server

Check Taskfiles status Check Go status Check Markdown status Check License status Check Go Dependencies status

The Arduino Language Server is the tool that powers the autocompletion of the new Arduino IDE 2. It implements the standard Language Server Protocol so it can be used with other IDEs as well.

Bugs & Issues

High quality bug reports and feature requests are valuable contributions to the project.

Before reporting an issue search existing pull requests and issues to see if it was already reported. If you have additional information to provide about an existing issue, please comment there. You can use the Reactions feature if you only want to express support.

Qualities of an excellent report:

  • The issue title should be descriptive. Vague titles make it difficult to understand the purpose of the issue, which might cause your issue to be overlooked.
  • Provide a full set of steps necessary to reproduce the issue. Demonstration code or commands should be complete and simplified to the minimum necessary to reproduce the issue.
  • Be responsive. We may need you to provide additional information in order to investigate and resolve the issue.
  • If you find a solution to your problem, please comment on your issue report with an explanation of how you were able to fix it and close the issue.

Security

If you think you found a vulnerability or other security-related bug in this project, please read our security policy and report the bug to our Security Team ๐Ÿ›ก๏ธ Thank you!

e-mail contact: [email protected]

How to contribute

Contributions are welcome! Here are all the ways you can contribute to the project.

Pull Requests

To propose improvements or fix a bug, feel free to submit a PR.

Pull request checklist

In order to ease code reviews and have your contributions merged faster, here is a list of items you can check before submitting a PR:

  • Create small PRs that are narrowly focused on addressing a single concern.
  • Write tests for the code you wrote.
  • Open your PR against the main branch.
  • Maintain clean commit history and use meaningful commit messages. PRs with messy commit history are difficult to review and require a lot of work to be merged.
  • Your PR must pass all CI tests before we will merge it. If you're seeing an error and don't think it's your fault, it may not be! The reviewer will help you if there are test failures that seem not related to the change you are making.

Build

To build the Arduino Language Server you need:

  • Go version 1.12 or later

The project doesn't require CGO so it can be easily crosscompiled if necessary. To build for you machine just run:

go build

To run tests:

go test -v ./...

Usage

The language server it's not intended for direct usage by humans via the command line terminal. The purpose of this program is to provide C++/.ino language-related functionality to the IDEs so, in general, it's the IDE that talks to the language server via stdin/stdout using the slightly modified JSONRPC protocol defined in the LSP specification.

The prerequisites to run the Arduino Language Server are:

To start the language server the IDE may provide the path to Arduino CLI and clangd with the following flags in addition to the target board FQBN:

./arduino-language-server \
 -clangd /usr/local/bin/clangd \
 -cli /usr/local/bin/arduino-cli \
 -cli-config $HOME/.arduino15/arduino-cli.yaml \
 -fqbn arduino:mbed:nanorp2040connect

The -fqbn flag represents the board you're actually working on (different boards may implement different features/API, if you change board you need to restart the language server with another fqbn). The support for the board must be installed with the arduino-cli core install ... command before starting the language server.

If you do not have an Arduino CLI config file, you can create one by running:

arduino-cli config init

Donations

This open source code was written by the Arduino team and is maintained on a daily basis with the help of the community. We invest a considerable amount of time in development, testing and optimization. Please consider donating or sponsoring to support our work, as well as buying original Arduino boards which is the best way to make sure our effort can continue in the long term.

License

The code contained in this repository is licensed under the terms of the GNU Affero General Public License version 3 license. If you have questions about licensing please contact us at [email protected].

More Repositories

1

Arduino

Arduino IDE 1.x
Java
14,104
star
2

arduino-cli

Arduino command line tool
Go
4,327
star
3

arduino-ide

Arduino IDE 2.x
TypeScript
2,230
star
4

ArduinoCore-avr

The Official Arduino AVR core
C
1,220
star
5

arduino-pro-ide

The Arduino IDE for advanced users and developers. Experimental alpha version.
884
star
6

ArduinoCore-samd

Arduino Core for SAMD21 CPU
C
463
star
7

arduino-builder

A command line tool for compiling Arduino sketches
Go
455
star
8

arduino-create-agent

The Arduino Create Agent
Go
415
star
9

ArduinoCore-mbed

C
345
star
10

ArduinoCore-arc32

C
327
star
11

ArduinoTensorFlowLiteTutorials

Jupyter Notebook
260
star
12

library-registry

Arduino Library Manager list
244
star
13

lab-micropython-editor

Arduino Lab for MicroPython is an Integrated Development Environment (IDE) for MicroPython.
JavaScript
220
star
14

ArduinoCore-API

Hardware independent layer of the Arduino cores defining the official API
C++
202
star
15

reference-en

Editable source for the Arduino Reference
165
star
16

docs-content

Arduino documentation (docs.arduino.cc)
Python
158
star
17

openwrt-yun

A custom version of OpenWrt, targeted to the Arduino Yรบn
C
148
star
18

toolchain-avr

The AVR toolchain used by the Arduino IDE
Shell
142
star
19

nina-fw

Firmware for u-blox NINA W102 WiFi/BT module
C
135
star
20

setup-protoc

GitHub Action to setup the protoc compiler for protocol buffers
TypeScript
134
star
21

OpenOCD

Fork of OpenOCD
C
119
star
22

ArduinoCore-renesas

C
111
star
23

setup-task

GitHub Actions action to make Task available for use in your workflow
TypeScript
104
star
24

arduino-lint

Tool to check for problems with Arduino projects
Go
104
star
25

linino

C
103
star
26

ArduinoCore-megaavr

Arduino Core for the ATMEGA4809 CPU
C++
103
star
27

wifishield

Arduino Wifi Shield
C
92
star
28

arduino-examples

Arduino IDE bundled examples
Shell
92
star
29

ArduinoCore-nRF528x-mbedos

[Archived] Arduino core supporting mbed-enabled boards
C
86
star
30

ArduinoCore-sam

HTML
79
star
31

setup-arduino-cli

GitHub Action to setup Arduino CLI
TypeScript
76
star
32

YunBridge

Python
72
star
33

BtSerial

A Bluetooth Serial library for Processing for Android
Java
71
star
34

ArduinoAI

Arduino AI content / demos
JavaScript
71
star
35

ArduinoCloudProviderExamples

Examples of how to connect various Arduino boards to cloud providers.
C
71
star
36

tutorials

C++
70
star
37

openwrt-packages-yun

Makefile
66
star
38

compile-sketches

GitHub Actions action that checks whether Arduino sketches compile and produces a report of data from the compilations
Python
65
star
39

AIoT-Dev-Summit-2019

C++
56
star
40

RXTX

Arduino version of RXTX
Shell
55
star
41

arduino-fwuploader

A Command Line Tool made to update the firmware and/or add SSL certificates for any Arduino board equipped with WINC or NINA Wi-Fi module.
Go
52
star
42

YunWebUI

Arduino/Genuino Yรบn or Yรบn Shield Web panel
JavaScript
51
star
43

arduino-preprocessor

Parses an Arduino Sketch and converts it into valid C++ source code
C++
49
star
44

Arduino-Science-Journal-Android

Use the sensors in your mobile devices to perform science experiments. Science doesnโ€™t just happen in the classroom or labโ€”tools like Science Journal let you see how the world works with just your phone.
Java
48
star
45

nicla-sense-me-fw

Arduino Nicla Sense ME resources (libraries, bootloader, host pc utilities)
C
47
star
46

language

This repository serves a central entry point to discussions concerning the Arduino Language.
46
star
47

arduino-lint-action

GitHub Actions action to check Arduino projects for problems
TypeScript
44
star
48

go-apt-client

Go
41
star
49

summer-of-code

Arduino @ Google Summer of Code
40
star
50

ArduinoCore-primo

Arduino core for nrf52 cpu
C
39
star
51

arduino-iot-js

Arduino IoT Cloud - Javascript SDK
JavaScript
38
star
52

ArduinoISP

C
37
star
53

TFTP-Bootloader

An unfinished TFTP bootloader for Arduino Ethernet
C
37
star
54

EduIntro

Arduino library aimed at making super-fast introductory workshops to Arduino. Based on the idea of having components as objects in the code.
C++
37
star
55

arduino-connector

Connector to the Arduino Create Cloud and IoT platform
Go
36
star
56

avrdude-build-script

avrdude build scripts for Arduino/Genuino
Shell
34
star
57

actions

Collection of custom Github actions
Python
34
star
58

arduino-create-agent-js-client

JS module providing discovery of the Arduino Create Plugin and communication with it
JavaScript
33
star
59

arduino-iot-cloud-py

Arduino IoT Cloud Python Client.
Python
28
star
60

mcuboot-arduino-stm32h7

C
27
star
61

uno-r4-wifi-usb-bridge

C++
27
star
62

arduino-usb-scanner

Tool that scans the USB bus autodetecting Arduino boards and their serial port names
26
star
63

uno-r4-library-compatibility

25
star
64

arduinoOTA

Go
25
star
65

rp2040tools

Go
23
star
66

iot-client-py

Python client for Arduino IoT API
Python
23
star
67

astyle

Scripts and patches used to build astyle, a code formatter used by the Arduino IDE
Shell
23
star
68

vscode-arduino-tools

Arduino Language Server extension for VS Code
TypeScript
23
star
69

arduino-cli-example

C++
23
star
70

ArduinoModule-CMSIS-Atmel

Atmel Smart ARM devices CMSIS module for Arduino IDE
C
23
star
71

iot-client-js

Javascript client for Arduino IoT API
JavaScript
23
star
72

mkrwan1300-fw

C++
22
star
73

dfu-utils-cross

scripts to compile (and cross-compile from a Linux machine) dfu-utils package for Linux (x86_64, x86, arm), OSX and Windows.
C
22
star
74

Arduino-Science-Journal-iOS

Use the sensors in your mobile devices to perform science experiments. Science doesnโ€™t just happen in the classroom or labโ€”tools like Science Journal let you see how the world works with just your phone.
Swift
22
star
75

Tests

Arduino
21
star
76

arduino-flash-tools

Arduino Tools for Create
C
21
star
77

HMC5983

Proof of concept of an Arduino library for Honeywell's HMC5983 magnetic sensor.
C++
20
star
78

serial-discovery

An Arduino IDE pluggable-discovery for Serial ports
Go
19
star
79

ethernet-bootloader

TFTP Bootloader for the Arduino Ethernet Board
C
19
star
80

iot-client-go

Go client for Arduino IoT API
Go
19
star
81

mdns-discovery

mdns (bonjour) pluggable discovery
Go
18
star
82

arduino-cloud-cli

Go
16
star
83

lab-micropython-installer

This repository hosts the entire code of the Arduino MicroPython Installer tool
C
16
star
84

cpp-test-action

A GitHub Actions action for testing C/C++ projects
15
star
85

serial-monitor

Arduino pluggable monitor for serial ports
Go
15
star
86

ctags

A mix of ctags and anjuta-tags for the perfect C++ ctags
C
15
star
87

livecast

Code for the examples presented at the Arduino Livecasts
C++
15
star
88

report-size-deltas

GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches
Python
14
star
89

openwrt-yun-1505

Updated build system for OpenWrt - Yun family boards
C
14
star
90

reference-pt

Portuguese version of the Arduino Reference
14
star
91

portenta-containers

TypeScript
14
star
92

the-things-conference

C
13
star
93

WiFi101-FirmwareUpdater-Plugin

WiFi101 Firmware Updater Tool for Arduino IDE
Java
13
star
94

reference-fr

12
star
95

libraries-repository-engine

Arduino Library Manager index manager
Go
12
star
96

lmp-manifest

Shell
12
star
97

season-of-docs

Arduino and Google's Season of Docs 2019
12
star
98

tooling-project-assets

A collection of reusable assets for Arduino tooling projects
Python
12
star
99

lede-yun

C
11
star
100

cloud-examples

Examples for Arduino Cloud
JavaScript
11
star