Skip to content

Configuration guide #173

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

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Conversation

gonX
Copy link
Member

@gonX gonX commented Mar 15, 2024

Preview:
Screenshot 2025-04-13 at 01-54-37 Guide Adding support for a new tablet - OpenTabletDriver

(screenshot is with #262 included)

Looking for fact checking, theming issues and TODO fixes.

Necessary fixes before merge:

  • h4/h5 theming
  • statically defined anchors

@gonX gonX added enhancement New feature or request wiki Improvements or additions to the wiki labels Mar 15, 2024
Copy link

@JaxCavalera JaxCavalera left a comment

Choose a reason for hiding this comment

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

This is awesome thank you for taking the time to put this together!

Copy link
Member

@jamesbt365 jamesbt365 left a comment

Choose a reason for hiding this comment

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

While this guide does not directly cover stuff like WinUSB, examples of bad/unopenable lengths and how to handle situations where multiple interfaces have the same lengths (interface attribute required), this is good!

It covers most bases and I don't really have much to be picky about, but heres some stuff I could think of while reading this.

@gonX gonX self-assigned this Jan 1, 2025
@gonX gonX force-pushed the configuration-guide branch from 2cc57f0 to 9dffb2d Compare April 12, 2025 15:36
@gonX gonX marked this pull request as draft April 12, 2025 15:37
gonX and others added 9 commits April 12, 2025 17:54
We always want a diagnostic file in a PR, reword it so that people can optionally put the report
lengths in the commit message
Used the following jq command to extract initialization strings from current configurations in
OpenTabletDriver codebase:

jq '{ name: .Name, InitializationStrings: .DigitizerIdentifiers[].InitializationStrings } | select(.InitializationStrings != null)' OpenTabletDriver.Configurations/Configurations/**/*.json
The following jq command was used to print out the device strings:

jq '{ name: .Name, DeviceStrings: .DigitizerIdentifiers[].DeviceStrings } | select(.DeviceStrings != null)' OpenTabletDriver.Configurations/Configurations/**/*.json
Co-authored-by: jamesbt365 <jamesbt365@gmail.com>
@gonX gonX marked this pull request as ready for review April 12, 2025 23:11
@gonX
Copy link
Member Author

gonX commented Apr 12, 2025

This should be ready to review again.

Copy link
Member

@Kuuuube Kuuuube left a comment

Choose a reason for hiding this comment

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

Looks really good. Just a few small things I noticed.

Comment on lines +148 to +156
Even if your tablet only has a single interface, it is often a good idea to
specify at least one of the lengths as non-zero, and only define them as `null`
if you know what you're doing

> If you specify report lengths as null, it can be hard to fix any future
conflicts that may arise without knowing what values your specific tablet
has. If you do decide to specify them as null, please make sure to include a
OpenTabletDriver diagnostics with the pull request, and optionally include
the lengths in the commit description.
Copy link
Member

Choose a reason for hiding this comment

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

Instead of metioning null this should now be omitting the values entirely.


#### Digitizer {#validation-parser-digitizer}

Verify that the top left of the tablet equals to `[0, 0]` or `[1, 1]`.
Copy link
Member

Choose a reason for hiding this comment

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

Probably worth noting that if the user has their tablet rotated physically it may not be the top left.


You will need the following values:

- The LPMM (lines per millimeter) of the tablet for both axises (horizontal and vertical).
Copy link
Member

Choose a reason for hiding this comment

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

The plural of axis is axes.

Suggested change
- The LPMM (lines per millimeter) of the tablet for both axises (horizontal and vertical).
- The LPMM (lines per millimeter) of the tablet for both axes (horizontal and vertical).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request wiki Improvements or additions to the wiki
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants