Skip to content

ports/alif/boards/ALIF_ENSEMBLE: Add deploy instructions. #17435

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.

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
merged 4 commits into from
Jun 26, 2025

Conversation

iabdalkader
Copy link
Contributor

@iabdalkader iabdalkader commented Jun 5, 2025

Summary

Add deploy/build instructions for Ensemble E7 DevKit.

Testing

I've tested these instructions, with another board, and they work fine. Testing with the devkit itself would be helpful.

@iabdalkader iabdalkader force-pushed the alif_e7_deploy_instructions branch from 5069017 to f435c5b Compare June 5, 2025 07:56
@iabdalkader
Copy link
Contributor Author

iabdalkader commented Jun 5, 2025

@dpgeorge I'm not sure how to add the firmware to the hosted files, we probably need to add the entire build dir. Could you please add it? Also, I don't have a devkit to test with, but I did test these instructions with AE3.

./ports/alif/boards/ALIF_ENSEMBLE/board.json unknown features: {'OSPI Flash', 'I2S/PDM Microphone', 'SD Card', 'OSPI HyperRAM', 'Joystick'}

I'm not really sure what the purpose of the "features" tag is, but I can just remove these.

@dpgeorge
Copy link
Member

I'm not sure how to add the firmware to the hosted files, we probably need to add the entire build dir.

I think we should add just the files that are needed for deployment over serial. To do that, we should create a target in the Makefile like package which packages up all the needed files into a .zip (or .tgz?). And then tools/autobuild/build-boards.sh can have a function added to it which builds and collects this .zip. That will be very similar to how the cc3200 port works.

@iabdalkader iabdalkader force-pushed the alif_e7_deploy_instructions branch 3 times, most recently from 91683fb to 52b9214 Compare June 10, 2025 08:50
@iabdalkader
Copy link
Contributor Author

I think we should add just the files that are needed for deployment over serial. To do that, we should create a target in the Makefile like package which packages up all the needed files into a .zip (or .tgz?). And then tools/autobuild/build-boards.sh can have a function added to it which builds and collects this .zip. That will be very similar to how the cc3200 port works.

This is fine with me, but it's probably best if you do this step. We could merge the build instructions and board images contained in this PR or feel free to push to the branch/cherry-pick the commits here.

@dpgeorge
Copy link
Member

I've now pushed 2 commits to this PR:

  • create firmware.zip as part of the alif build process, containing relevant files needed to deploy over SEUART
  • add alif to the auto-build scripts, so the boards are built along with all the other boards

I didn't test the zip yet!

Copy link

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

Copy link

codecov bot commented Jun 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.57%. Comparing base (2f04381) to head (9b38cf9).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #17435   +/-   ##
=======================================
  Coverage   98.57%   98.57%           
=======================================
  Files         169      169           
  Lines       21968    21968           
=======================================
  Hits        21654    21654           
  Misses        314      314           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@kwagyeman
Copy link
Contributor

Tested the build and everything works.

@iabdalkader
Copy link
Contributor Author

@dpgeorge Is the readme/deploy here clear enough? Should we move forward with this PR?

dpgeorge and others added 3 commits June 26, 2025 13:25
The resulting `firmware.zip` file is self contained with everything needed
to deploy the firmware, eg over SE UART.

Signed-off-by: Damien George <[email protected]>
The firmware for this board will now be built and available automatically.

Signed-off-by: iabdalkader <[email protected]>
@dpgeorge dpgeorge force-pushed the alif_e7_deploy_instructions branch from a8d3ef5 to 5b0fb29 Compare June 26, 2025 03:26
Copy link
Member

@dpgeorge dpgeorge left a comment

Choose a reason for hiding this comment

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

I tested this on an Alif dev kit by following the instructions here, and the system package update works, along with the firmware install.

@dpgeorge dpgeorge force-pushed the alif_e7_deploy_instructions branch from 5b0fb29 to 9b38cf9 Compare June 26, 2025 03:28
@dpgeorge dpgeorge merged commit 9b38cf9 into micropython:master Jun 26, 2025
69 checks passed
@iabdalkader iabdalkader deleted the alif_e7_deploy_instructions branch June 26, 2025 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants