Repository navigation
Wiki update #881
Description
Hey guys!
Awesome work done on the project 🥳 . I just finished setting up my first device with tinypilot and looks promising 😃 .
I wanted to contribute with some minor issues I found on the documentation. Before I list them down let me first tell you about my setup.
SBC: Raspberry Pi Zero W
HDMI capture: C779 CSI-HDMI bridge module
Steps I followed:
- Install everything as default following repo
README.md(everything went smooth) you can see the output if needed on the installation_001.log file. - Edit the
settings.ymlwith the needed attributes/variables for the rpi 0 (It failed) the output is in the installation_002.log file.
- The attributes/variables were as in the Pi Zero Optimizations page:
ustreamer_desired_fps: 15 ustreamer_drop_same_frames: 15
- Edit once again the
settings.ymlwith theustreamer_use_dv_timings: trueattribute/variable as I saw it on the issue #93 ending with asetting.yamlfile like this:ustreamer_capture_device: "tc358743" ustreamer_use_dv_timings: true ustreamer_desired_fps: 15 ustreamer_drop_same_frames: 15 ustreamer_port: 8001 ustreamer_persistent: true ustreamer_encoder: omx ustreamer_format: uyvy ustreamer_resolution: 1920x720
Now to the files I visited that IMHO, have missing or wrong information:
- Pi Zero Optimizations
- Would be great to add how to edit the
settings.ymlvia command line as in other pages.
- Would be great to add how to edit the
- Example: TC358743 HDMI to CSI capture chip
- No reference to the
USE_TC358743_DEFAULTSvariable seen in the quick-install script. (I know it's being set by reading thesettings.yamlfile but for some reason on the 3rd tried it work setting that variable before executing the script (Even with the script setting it up as empty on that line).
- No reference to the
- Installation Options
- It references a
TINYPILOT_SETTINGSvariable which seems not correct as per the quick-install looks for aTINYPILOT_SETTINGS_FILE
- It references a
- All pages above
- I didn't find any information on how to create the user so I finally prior executing any of the commands proposed I needed to create the user and the group with
sudo useradd --create-home --system --user-group tinypilot - Maybe would be great to have a separate wiki page for editing the
settings.ymlfile
- I didn't find any information on how to create the user so I finally prior executing any of the commands proposed I needed to create the user and the group with
- Contributing
- No section on how to edit the wiki or how to proceed or how to help on documenting.
- No section regarding translation (I can help on the Spanish part)
P.D:
- If any more information is needed, do ask me 😛
- I can add these changes to the wiki if required. (Just need to know the procedure, like, if it is needed to activate the hooks when there is no code developed)
Activity
mtlynch commentedon Jan 7, 2022
Thanks for this!
Sorry for the delay on responding. I'm hoping to get to this next week.
yeyeto2788 commentedon Jan 10, 2022
No problem. If you want me to do something, let me know.
mtlynch commentedon Jan 19, 2022
Sorry again for the delay!
We could, but it's a little ugly to make sure we're doing it idempotently. If we run the same command 10 times, it shouldn't just add the same line, but it's a bit more complicated to implement it to prevent that.
The user can't set the
USE_TC358743_DEFAULTSvariable, as it gets set in the script itself. What you can do is set add this line to/home/tinypilot/settings.yml:It didn't take effect before because the documentation had quotes around
tc358743, but the grep is not flexible on quotes. I've updated the examples to get rid of the quotes.The two variables are independent. Both only have meaning locally within the script/example.
Ah, you're right. That should have been a first step in the advanced installation instructions. I've added that to the examples.
Github doesn't have tools for letting us review wiki changes effectively, so it's basically just that anyone's allowed to edit, and everyone does their best to keep it accurate and clear.
We unfortunately don't have resources to support multi-language documentation or UI, but if you publish a Spanish-language tutorial, I'll link to it.