Skip to content

Commit

Permalink
docs: update server_configurations.md
Browse files Browse the repository at this point in the history
skip-checks: true
  • Loading branch information
github-actions[bot] committed Oct 26, 2023
1 parent bd1b4dc commit cb49a4c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 22 deletions.
17 changes: 6 additions & 11 deletions doc/server_configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ $ arduino-cli sketch new test
$ cd test
```

You will need a `sketch.json` file in order for the language server to understand your project. It will also save you passing options to `arduino-cli` each time you compile or upload a file. You can generate the file like using the following commands.
You will need a `sketch.yaml` file in order for the language server to understand your project. It will also save you passing options to `arduino-cli` each time you compile or upload a file. You can generate the file like using the following commands.


First gather some information about your board. Make sure your board is connected and run the following:
Expand All @@ -614,27 +614,22 @@ Port Protocol Type Board Name FQBN Core
Then generate the file:

```sh
arduino-cli board attach -p /dev/ttyACM0 test.ino
arduino-cli board attach -p /dev/ttyACM0 -b arduino:avr:uno test.ino
```

The resulting file should like like this:

```json
{
"cpu": {
"fqbn": "arduino:avr:uno",
"name": "Arduino Uno",
"port": "serial:///dev/ttyACM0"
}
}
```yaml
default_fqbn: arduino:avr:uno
default_port: /dev/ttyACM0
```
Your folder structure should look like this:
```
.
├── test.ino
└── sketch.json
└── sketch.yaml
```

For further instruction about configuration options, run `arduino-language-server --help`.
Expand Down
17 changes: 6 additions & 11 deletions doc/server_configurations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ $ arduino-cli sketch new test
$ cd test
```

You will need a `sketch.json` file in order for the language server to understand your project. It will also save you passing options to `arduino-cli` each time you compile or upload a file. You can generate the file like using the following commands.
You will need a `sketch.yaml` file in order for the language server to understand your project. It will also save you passing options to `arduino-cli` each time you compile or upload a file. You can generate the file like using the following commands.


First gather some information about your board. Make sure your board is connected and run the following:
Expand All @@ -614,27 +614,22 @@ Port Protocol Type Board Name FQBN Core
Then generate the file:

```sh
arduino-cli board attach -p /dev/ttyACM0 test.ino
arduino-cli board attach -p /dev/ttyACM0 -b arduino:avr:uno test.ino
```

The resulting file should like like this:

```json
{
"cpu": {
"fqbn": "arduino:avr:uno",
"name": "Arduino Uno",
"port": "serial:///dev/ttyACM0"
}
}
```yaml
default_fqbn: arduino:avr:uno
default_port: /dev/ttyACM0
```

Your folder structure should look like this:

```
.
├── test.ino
└── sketch.json
└── sketch.yaml
```

For further instruction about configuration options, run `arduino-language-server --help`.
Expand Down

0 comments on commit cb49a4c

Please sign in to comment.