Skip to content

hub updater documentation - #127

Draft
cjsha wants to merge 3 commits into
mainfrom
hub-updater
Draft

hub updater documentation#127
cjsha wants to merge 3 commits into
mainfrom
hub-updater

Conversation

@cjsha

@cjsha cjsha commented Nov 11, 2025

Copy link
Copy Markdown
Member

No description provided.

@cjsha
cjsha requested a review from jonnew November 11, 2025 00:37
@cjsha
cjsha marked this pull request as draft November 11, 2025 00:38

@cjsha cjsha left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

list of todos for myself:

  • this first commit uses a zipped version of the GUI that I built locally from a PR. I need to take care to use the version ends up getting merged to main (ideally a pre-built download that's contained in the Releases page)

  • If there are any visual changes when the official release is out, screenshots might need to be updated

  • Document failure modes (here's a screenshot for example):
    hub-updater_hw-mismatch
    image

  • Include latest Headstage 64 0.4.0 firmware images

@aacuevas

Copy link
Copy Markdown
Contributor

Can you please describe what caused the two errors that you show?

Depending on which and how I might be able to clarify the error text itself.

(also one of them seems to have a typo?)

@cjsha

cjsha commented Nov 11, 2025

Copy link
Copy Markdown
Member Author

Just for clarification, when I say "document failure modes", these are not instances of the GUI failing, they're instances of the user failing to select the correct options.


hub-updater_hw-mismatch

This happens if you try a rhs2116 headstage with firmware intended for hs64 (e.g. if a user selects the wrong port with two different devices connected)


image

This happens if you try using this on a computer where onix isn't plugged in :P not even sure this is worth mentioning


I also came across this, but it seems pretty straightforward already

image

I didn't try to see what happens if there is no headstage connected at all, but it seems like it would be a different error than the ones presented above.

@aacuevas

Copy link
Copy Markdown
Contributor

Ok, thanks!
I need to check the first message at least. It should first check for device ID and then hw revision after.
Also, I need to spellfix recision to revision

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.

2 participants