Skip to content

Update readme with device shadow desired to reported transformation #24

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

Merged
amclain merged 1 commit into from
Aug 20, 2025
Merged

Update readme with device shadow desired to reported transformation #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,17 +254,26 @@ The new, unknown fields will be filtered out of `message` during the validation
Using `meta`, the unknown fields can be selected with a filter, and they can be merged into the `reported` map to send to the shadow.

```elixir
reported = %{
# Real data to report to the shadow ...
shadow = %{
state: %{
reported: %{
# Real data to report to the shadow ...
}
}
}

meta
|> Attribute.list
|> Enum.filter(fn
{_path, :unknown, _value} -> true
# Only capture the device shadow state, not the metadata.
{["state" | _rest], :unknown, _value} -> true
{_path, _status, _value} -> false
end)
|> Attribute.merge(reported)
|> Enum.map(fn
{["state" | rest], status, value} ->
{["state", "reported"] ++ rest, status, value}
)
|> Attribute.merge(shadow)
```

### Fields as actions
Expand Down