Skip to main content

EtherCAT Module Documentation

Welcome to the documentation for the EtherCAT module product family. These docs cover everything from EtherCAT fundamentals to integrating our hardware modules into your own designs and driving them from our Linux master software.

note

The content here is placeholder/sample text. The structure is intentionally simple and expandable so pages and sections can be added over time.

What's in these docs​

  • EtherCAT Basics - A high-level introduction to EtherCAT, devices, and how communication works.
  • Master Software - Our Linux EtherCAT master software, including a C++ hello-world example.
  • Hardware Integration - How to integrate the hardware modules into your own PCB.

How this documentation is organized​

The site uses an autogenerated sidebar: the navigation is built directly from the folder structure under docs/. This keeps maintenance low as the documentation grows.

Adding a new page​

Drop a new .md or .mdx file into the relevant section folder, for example docs/master-software/api-reference.md. It will appear in the sidebar automatically. Use the sidebar_position front matter field to control ordering within a section.

Adding a new section​

Create a new folder under docs/ and add a _category_.json file to give it a label and position:

{
  "label": "My New Section",
  "position": 5,
  "link": { "type": "generated-index" }
}

Future enhancements​

The architecture supports standard Docusaurus features that can be layered on later without restructuring content:

  • Versioned documentation
  • Full-text search (Algolia DocSearch or a local search plugin)
  • Internationalization (i18n)