Skip to content

[json] Add a note reminding people to put json: in config to use json #5397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: current
Choose a base branch
from
Open

[json] Add a note reminding people to put json: in config to use json #5397

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
799719a
Add a note
ChadMatsalla Sep 24, 2025
fead890
Add bunny suggestion
ChadMatsalla Sep 24, 2025
370cd39
De-lint
ChadMatsalla Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions content/components/json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ Example 2: Simple JSON:
{"key": 42.0, "greeting": "Hello World"}
```

> [!NOTE]
> To use the json component, you need to include it in your config. Be sure to put `json:` at the root level, along with other components like `esphome:`.

## Parsing JSON

This example assumes that the server returns a response as a JSON object similar to this:
Expand Down Expand Up @@ -120,6 +123,6 @@ Another important resource is [JSONLint](https://jsonlint.com/). It will help yo
## See Also

- {{< docref "index/" >}}
- {{< apiref "http_request/http_request.h" "http_request/http_request.h" >}}
- {{< apiref "json/json_util.h" "json/json_util.h" >}}
- {{< apiref "HTTP Request" "http_request/http_request.h" >}}
- {{< apiref "json_util.h" "json/json_util.h" >}}
- [ArduinoJson](https://arduinojson.org/)