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

Documentation with ReadTheDocs #42

Open
8 tasks
JJL772 opened this issue Jun 6, 2023 · 0 comments
Open
8 tasks

Documentation with ReadTheDocs #42

JJL772 opened this issue Jun 6, 2023 · 0 comments

Comments

@JJL772
Copy link
Member

JJL772 commented Jun 6, 2023

The manual contained in this repo needs updating. Ideally entirely new documentation should be written following the pattern of PCDS documentation.

Some topics that should be covered in the new documentation (in no particular order):

  • Compiling the module
  • Setting up an IOC
  • Limitations
  • List of supported terminals
  • Commissioning terminals: Basic instructions, selecting the correct PDO mapping
  • Commissioning analog terminals: supported presentations, configuring for alternative presentations (i.e. MSB)
  • Commissioning motor terminals: supported PDO types, limitations, etc.
  • Adding support for new terminals: details of PDO type safety system, etc.
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

1 participant