Skip to content

Add Daisy Chain Protocol Documentation and instructions on how to build and flash#154

Merged
elsevers merged 23 commits into
next-releasefrom
feature/dcp-documentation
May 17, 2026
Merged

Add Daisy Chain Protocol Documentation and instructions on how to build and flash#154
elsevers merged 23 commits into
next-releasefrom
feature/dcp-documentation

Conversation

@mohamed-dek1

@mohamed-dek1 mohamed-dek1 commented May 4, 2026

Copy link
Copy Markdown
Contributor

Closes #153 and #163

Notes

Anything reviewers should be aware of when reviewing? Other related issues? Known problems? Future work?

Self-Review

  1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
  2. Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
  3. Do all Markdown files follow the CONTRIBUTING article template? No
  4. Do all links work in the material that the PR is adding? Yes
  5. Is the PR configured to close the correct issue(s)? Yes
  6. Did the PR fully address the Approach section of the issue(s) it is closing? Yes

Reviewer Instructions

Reviewers, please copy and paste a suitable review checklist into your review and answer all questions.

Appendix

This section should be the same for all PRs. Do not edit this section when creating a PR.

Review Checklists

Checklists maintained by the eLev lab for research repositories include:

Standard checklist

1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? **Yes or No**
2. Are all files named according to the appropriate [naming convention](https://github.com/Severson-Group/research-repo-template?tab=readme-ov-file#file-naming), i.e., dash-case, camelCase, snake case? **Yes or No**
3. Do all Markdown files follow the [CONTRIBUTING article template](https://github.com/Severson-Group/.github/blob/main/CONTRIBUTING.md#markdown-documentation-template)? **Yes or No**
4. Do all links work in the material that the PR is adding? **Yes or No**
5. Is the PR configured to close the correct issue(s)? **Yes or No**
6. Did the PR fully address the `Approach` section of the issue(s) it is closing? **Yes or No**

Please work on addressing any **No** items.

@mohamed-dek1 mohamed-dek1 requested a review from elsevers May 4, 2026 21:00
@mohamed-dek1 mohamed-dek1 self-assigned this May 4, 2026
@mohamed-dek1 mohamed-dek1 changed the title Feature/dcp documentation Add Daisy Chain Protocol Documentation May 4, 2026
@mohamed-dek1

Copy link
Copy Markdown
Contributor Author

@elsevers, there is documentation on the Daisy Chain Protocol along with programming the AMDS. can you review this?

@elsevers elsevers left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

To do:

  • Update benchmark data for single AMDC-AMDS
    • Tracked here: #165
  • On daisy chain page:
    • add daisy chain benchmark data (3x AMDS's with 8 cards each, 3x 2S boards with 2 cards each)
    • remove discussion that reads like a diff
    • Explain a bit more on how it works (yes, discussion of DMA is good)
    • Cabling! Pinouts to wire it all up. What pins go to what pins.
      • Tracked here: #166
    • Explain how the header packets from each AMDS are adjusted as they progress through the chain and then what registers in the AMDC Firmware (AMDS_CH_1_DATA_REG_OFFSET - AMDS_CH_24_DATA_REG_OFFSET) they ultimately appear in.
      • Tracked here: #158

```

```{warning}
Ensure that you

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Incomplete

@elsevers elsevers changed the base branch from main to feature/amdc-v2-docs May 17, 2026 16:19
@elsevers elsevers linked an issue May 17, 2026 that may be closed by this pull request
@elsevers elsevers changed the title Add Daisy Chain Protocol Documentation Add Daisy Chain Protocol Documentation and instructions on how to build and flash May 17, 2026
@elsevers elsevers changed the base branch from feature/amdc-v2-docs to feature/amdc-next-release-docs May 17, 2026 19:30
@elsevers elsevers changed the base branch from feature/amdc-next-release-docs to next-release May 17, 2026 19:32
Removed warning block from profiling tasks tutorial.

@elsevers elsevers left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I have gone through this thoroughly, completing the minimum required to release this and splitting out other items into new issue. Let's merge this now into our next-release staging area.

@elsevers elsevers merged commit 007b5aa into next-release May 17, 2026
@elsevers elsevers deleted the feature/dcp-documentation branch May 17, 2026 19:35
AwesomeTornado added a commit that referenced this pull request Jun 12, 2026
* Add Daisy Chain Protocol Documentation and instructions on how to build and flash (#154)

* add initial docs and changes to firmware docs

* add initial building and flashing documentation

* remove future improvement 4

* remove 10khz host rate

* make flash and daisy chain be subarticles of firmware

* clarify that baud rate is now 20 Mbps

---------

Co-authored-by: Eric Severson <sever@umn.edu>

* fix implicit-link build warning

* add table mapping daisy chained AMDS sensor card to AMDC (#171)

* Add description of custom cable required for daisy chain adapter (#172)

* Add image illustrating placement of the daisy chain adapter board

* Add description of custom cable

* Add dark mode graphics for DCA

* Update amds timings (#178)

* update numbers and graph

* Add new packet capture graphic

* Delete old image

* Update images

* Update sampling timing font

---------

Co-authored-by: Harley Peterson <pet05059@umn.edu>

* Add board def download link (#180)

* Add board definition download link

* update typo

* Fix another typo

---------

Co-authored-by: Mohamed-dek Mohamed <mohameddekmohamed1@gmail.com>
Co-authored-by: Harley Peterson <73045075+AwesomeTornado@users.noreply.github.com>
Co-authored-by: Harley Peterson <pet05059@umn.edu>
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.

Update AMDS docs to explain daisy chain protocol Add docs page explaining how to build and flash the AMDS

2 participants