Skip to content

Conversation

@banchan86
Copy link
Contributor

@banchan86 banchan86 commented May 31, 2025

Description

This PR creates the tutorial infrastructure base and adds the Getting Started (Setup) article for the Harp Hobgoblin to be used for the ESC-2025 course. Follows the format discussed in this link. I decided to break down the tutorials into separate PRs for each worksheet, so that each worksheet can be merged in earlier when completed (in case we still have to polish the later worksheets closer to the workshop day). This PR should be merged in before the rest though.

Changes

  • Updates all existing submodules (wasn't sure if this was necessary, but it didn't seem to break anything)
  • Adds device.harpgoblin to src
  • Add tutorials folder and toc.yml
  • Adds "Getting Started" article

Consideration

  • One important consideration is that the tutorials will be present on the website beyond the workshop, so the content was adapted accordingly. For instance, I introduced the device name as a group heading, making it clearer that the tutorials were made for that device in mind. However i did add a line at the top of the article that says the principles learned in this tutorial series can be adapted to other devices. I am also wondering now if we should be a little less specific in say naming certain parts (for instance, saying add a photodiode instead of naming the part).
  • For the "Hello World" example, I did not really cover the "Device" operator and the "Parse" operator as I feel that the actual learning of these operators should be pushed to the acquisition tutorial.

Issues

  • I spent some time investigating if we could use fritzing to implement the wiring diagrams, unfortunately the DFrobot parts (gravity expansion shield, sensors) are not available as fritzing parts and I do not think we have time to convert/make them as fritzing parts. There leaves us with several options listed, in order of time to complete them:
    • Take actual pictures of the wiring (@jfrazao might need to help with that as I don't have the actual gravity sensor kit)
    • Implement fritzing diagrams with generic parts (pico without gravity shield, generic sensors). Actually with the consideration above, this might be the way to go if we don't want to tie people into specific parts.
    • Overlay fritzing components on top of images/illustrations from DFrobot. So I tested this out and this actually isn't as bad as I thought it would be. Its just going to take a lot of time I think.

Pico_and_GravityShield

In any case, I left the wiring diagram for later depending on what we decide and have left a placeholder for the wiring diagram for the "Hello World" example.

I have also created a harp_fritzing_resources repository with the resources if anyone wants to play around with them, I will update and add to them as I go along (but creating these images are not my priority at the moment, I figure if we run out of time we can substitute with actual pictures or wiring can be shown during the course).

Online preview at link

@glopesdev glopesdev self-requested a review June 4, 2025 06:59
Copy link
Contributor

@glopesdev glopesdev left a comment

Choose a reason for hiding this comment

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

Looks good in general, my main concern is upgrading the submodules separately and avoiding pulling in the latest changes in the protocol repo as this would have functional implications beyond this tutorial.

@glopesdev glopesdev marked this pull request as ready for review June 4, 2025 09:10
@glopesdev glopesdev self-requested a review June 4, 2025 09:10
@glopesdev glopesdev merged commit 20dad9c into harp-tech:main Jun 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants