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.

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

pinout documentation: proteus links not in browser address bar on Proteus black 23 #3365

Closed
rusefillc opened this issue Oct 19, 2021 · 8 comments

Comments

@rusefillc
Copy link
Contributor

rusefillc commented Oct 19, 2021

all in Chrome:

step 1: open https://rusefi.com/docs/pinouts/microrusefi/
step 2: click on pin 5

result: browser URL has exact URL of pin 5, great https://rusefi.com/docs/pinouts/microrusefi/?connector=main&pin=5

image

step 3: open https://rusefi.com/docs/pinouts/proteus/
step 4: click on pin 5

result: no change in browser URL
expected result: explicit URL of pin 5

image

@rusefillc rusefillc changed the title pinout documentation: proteus links not in browser address bar pinout documentation: proteus links not in browser address bar on Proteus black 23 Oct 19, 2021
@chuckwagoncomputing
Copy link
Member

Proteus does not have the necessary information in the yaml for this feature to work.

@rusefillc
Copy link
Contributor Author

I am not very smart. I've looked at white35.yaml and mre main.yaml and I do not understand the difference.

also I was assuming that pin: 2 is the unique ID to be used here?

@chuckwagoncomputing
Copy link
Member

The important field here is the id field in the info section. I did mention this in #3012, but perhaps I wasn't explicit enough that it was necessary.
Also missing is the name field in the info section, which just adds a label above the connector.

@rusefillc
Copy link
Contributor Author

Progress, thank you for your patience.

So 7f5b4b7

Let's make those fields mandatory? it looks like current flexibility is just too confusing - at the moment there is no way for a human to guess what fields missing or present cause what effects.

If we simply make those mandatory we would be in a much simpler to comprehend situation

I am happy to adjust all files once generator starts to fail

@rusefillc
Copy link
Contributor Author

@chuckwagoncomputing we have a problem. Should I revert #3950?

image

I believe those pins in question cannot really have ID?

  - pin: 23
    function: Crank Pos/Trigger #1 +

  - pin: 24
    function: Crank Neg/Trigger #1 -

  - pin: 25
    function: Cam Pos/Trigger #2 +

is the root cause that "id" should not be primary key but "pin" should?

@chuckwagoncomputing
Copy link
Member

Maybe the error message isn't clear enough. The id field goes in the info section; it's not something that each pin has, but rather a single id for the whole connector.
Example:

Frankenso doesn't even have the info section, and until now the pinout generation has just failed silently. I haven't looked, but I'm sure it's not the only board that doesn't have it.
Maybe we should just print an error message and not fail the whole workflow? i.e. revert the change to misc/jenkins/generate_pinouts/gen_upload_pinouts.sh

@rusefillc
Copy link
Contributor Author

rusefillc commented Feb 20, 2022

Oh gotcha

I've just pushed something and poked the action again

@rusefillc
Copy link
Contributor Author

it's green again!

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

No branches or pull requests

2 participants