opulo-inc / opulo-inc/docs

Suggestions for improved OpenPnP install experience.

Open
#147 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

suggestion
Dominant language
Python
Stars
19
Forks
36
PR merge metrics
No merged PRs in 30d

Description

There is a lot here and the udev rule may be a bit much for a new install, but would be useful depending on what is going on on the machine along with OpenPnP

Start Location

You currently have to get three pages into the documentation on installing OpenPnP before its telling you what to do. This should go before the video on calibration.
image

Installing OpenPnP

The Linux install instructions here: (https://docs.opulo.io/openpnp/calibration/1-import-config/) Step 6 has you press CTRL + H in Nautilus to find hidded files (.openpnp2) which will not exist unless you have run OpenPnP. You need steps:
1.1 Install jre
1.2 Install OpenPnP with Software Installer
1.3 Run OpenPnP to cause it to create hidden configuration folder
1.4 Exit OpenPnP Same st step 8. (edited)
Importing Config Files - Opulo Documentation
Install OpenPNP and import default config

Lumen Configuration Folder Naming

The extracted Lumen Configuration files are in a folder called "openpnp 4" and you need to copy them to a folder called ".openpnp2". This is confusing because its seems like there is a version mismatch.

Note on backups

Step 9: Make sure there is a backup.... It looks like OpenPnP makes them for you. Do you really need to make another one? Stephen says he's been burned, but if this is a new install it's probably not necessary.

Cameras

On the https://docs.opulo.io/openpnp/calibration/2-connect-to-machine/ page before step 2 you should add a step to select "Show All Vertical" so that the users screen looks like the instructions. Had I not had previous OpenPnP experience this probably would be confusing.
image

Video Group

This page also says that you need to join the video group. This should have been done previously when joining the dialout group when installing the software.
...because I probably need to join the group and now restart the software.

udev rules for ttyACM0

On https://docs.opulo.io/openpnp/calibration/2-connect-to-machine/#serial-port-config step 4, consider adding udev rules to name the ttyACM0 since this name could be different depending on what is plugged into the machine.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the Importing Config Files and Connect to Machine documentation pages, including the serial-port-config section, and compare their current installation flow with the requested changes. Done means the install location, Linux prerequisites, configuration-folder naming, camera display setting, group setup, backup guidance, and serial-device guidance are clear and consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
linux
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.