Skip to content
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

[RSDK-8932] ota docs, local server #361

Merged
merged 15 commits into from
Dec 19, 2024
Merged

[RSDK-8932] ota docs, local server #361

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c455f0a
first draft
mattjperez Dec 9, 2024
dbcd06d
update build commands to use ota
mattjperez Dec 9, 2024
10ab511
add local ota server for testing
mattjperez Dec 10, 2024
af3e08b
small changes
mattjperez Dec 10, 2024
a6bdcc2
undo changes
mattjperez Dec 10, 2024
040524a
fix targetdir when serving from workspace root
mattjperez Dec 11, 2024
e3e06d3
update cargo lock
mattjperez Dec 11, 2024
3fe7f7e
Merge branch 'main' into rsdk-8932-ota-docs
mattjperez Dec 17, 2024
2a02ece
add doc suggestions, TODO update ota-server name,deps
mattjperez Dec 18, 2024
2d2bee1
more doc suggestions
mattjperez Dec 19, 2024
2b8a68d
service json formatting
mattjperez Dec 19, 2024
5baea09
fmt using github editor
mattjperez Dec 19, 2024
b7840b7
update ota-server to ota-dev-server
mattjperez Dec 19, 2024
18b1bb1
additional links
mattjperez Dec 19, 2024
146b257
add suggestions, put --flash-size back
mattjperez Dec 19, 2024
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
234 changes: 234 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ members = [
"micro-rdk-server",
"micro-rdk-ffi",
"examples/modular-drivers",
"etc/ota-server",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's call this "ota-dev-server" or "ota-test-server" to clarify that it isn't meant for production use.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, forgot about this one. Please remember to rename this before merge.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, making those code changes now

]

default-members = [
Expand Down
11 changes: 7 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ upload: cargo-ver
cargo +esp espflash flash --package micro-rdk-server --monitor --partition-table micro-rdk-server/esp32/partitions.csv --baud 460800 -f 80mhz --bin micro-rdk-server-esp32 --target=xtensa-esp32-espidf -Zbuild-std=std,panic_abort

test:
cargo test -p micro-rdk --lib --features native
cargo test -p micro-rdk --lib --features native,ota

clippy-native:
cargo clippy -p micro-rdk --no-deps --features native -- -Dwarnings
cargo clippy -p micro-rdk --no-deps --features native,ota -- -Dwarnings

clippy-esp32:
cargo +esp clippy -p micro-rdk --features esp32,ota --target=xtensa-esp32-espidf -Zbuild-std=std,panic_abort -- -Dwarnings
Expand Down Expand Up @@ -99,12 +99,15 @@ doc-open:
size:
find . -name "esp-build.map" -exec ${IDF_PATH}/tools/idf_size.py {} \;

build-esp32-bin:
cargo +esp espflash save-image --package micro-rdk-server --merge --chip esp32 target/xtensa-esp32-espidf/micro-rdk-server-esp32.bin -T micro-rdk-server/esp32/partitions.csv -s 4mb --bin micro-rdk-server-esp32 --target=xtensa-esp32-espidf -Zbuild-std=std,panic_abort --release
build-esp32-bin: build-esp32-ota
acmorrow marked this conversation as resolved.
Show resolved Hide resolved
cargo +esp espflash save-image --package micro-rdk-server --features=ota --merge --chip esp32 target/xtensa-esp32-espidf/micro-rdk-server-esp32.bin -T micro-rdk-server/esp32/ota_8mb_partitions.csv -s 8mb --bin micro-rdk-server-esp32 --target=xtensa-esp32-espidf -Zbuild-std=std,panic_abort --release
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are getting really quite long, and there are some subtle differences between the two commands that are obscured by other minor variations. Could you please:

  • Go multi-line for these
  • Ensure the flag order between build-esp32-bin and build-esp32-ota is the same, and use the same form of each flag (-T vs --partition-table), and convert any short-form arguments (e.g. -s) into long form?
  • While you are here, could you add --skip-update-check as well?
build-esp32-ota:
        cargo +esp espflash save-image \
            --package micro-rdk-server \
            ...
            --partition-table micro-rdk-server/esp32/ota_8mb_partitions.csv \
            --flash-size 8mb

etc.


build-esp32-ota:
cargo +esp espflash save-image --package micro-rdk-server --features=ota --chip=esp32 ./target/xtensa-esp32-espidf/micro-rdk-server-esp32-ota.bin --bin=micro-rdk-server-esp32 --partition-table=micro-rdk-server/esp32/ota_8mb_partitions.csv --target=xtensa-esp32-espidf -Zbuild-std=std,panic_abort --release

serve-ota: build-esp32-ota
cargo r --package ota-server

flash-esp32-bin:
ifneq (,$(wildcard ./target/xtensa-esp32-espidf/micro-rdk-server-esp32.bin))
espflash write-bin 0x0 ./target/xtensa-esp32-espidf/micro-rdk-server-esp32.bin --baud 460800 && sleep 2 && espflash monitor
Expand Down
Loading
Loading