Using these docs

How the docs are organized

The tabs in the header are the products, in this order: Get started, SECS/GEM, Modbus, MQTT, OPC UA, and Tools. Choose a tab, and the sidebar on the left lists that product’s pages. Every product has the same sections:

Section	Contents
Background	Concepts grounded in the standards, with the standard document and section.
Quickstart	Confirm a first exchange in a few minutes.
Tutorials	Exercises with a goal, what you need, numbered steps with commands and expected results, common errors, and clean-up. The Before you begin box at the top lists the background pages you need.
Guides	Task-oriented guides for the simulator GUI, headless runs, MCP, and configuration.
API reference	The C, C++, and .NET APIs, generated from the comments in the source code.
Troubleshooting	Causes and fixes by error message and status code.

Use On this page on the right to jump to a section. Code examples carry the real file name from the examples folder as their title; they show those files as they are, so they match the examples you received.

GUI menus, buttons, and fields appear in bold, exactly as the English GUI shows them, such as Start lab. Commands, file names, and function names appear in code format.

Switch languages

Use the language picker in the header to switch between Korean and English; it opens the same page in the other language. On the public site, Korean pages live under https://pdcomm.podosoft.io/docs/… and English pages under https://pdcomm.podosoft.io/docs/en/…, with the rest of the path identical. The offline copy drops the leading /docs.

API reference descriptions come from the English comments in the source code. On the Korean pages, when a Korean translation doesn’t match the latest English text, the English text appears with a pending-translation badge.

Search

Click the search box in the header, or press Ctrl+K (Cmd+K on macOS). Search covers the docs and the API reference in the language you’re reading. Function names and error messages work as search terms too.

API reference and changelog

In each product’s API reference, choose C, C++, or .NET. Each symbol page shows the signature, description, parameters, return value, and declaration. Additions, changes, and removals in the public API are listed in the API changelog.

Read offline

Where there’s no internet connection, use the offline docs bundle (a ZIP file). It contains:

pdcomm-docs/
├── START-HERE.ko.txt, START-HERE.en.txt   how to open the site
├── bin/pdcomm-docs                        the docs CLI (pdcomm-docs.exe on Windows)
├── site/                                  the complete docs site
├── THIRD-PARTY-NOTICES.txt                notices for third-party code in the site
└── manifest.json                          file list and SHA-256 hashes

Search only works when you open the site through a web server; a browser can’t load the search index from HTML files you open directly. Use one of these two ways:

Open it with pdcomm-docs, from the extracted pdcomm-docs folder:
터미널 창
```
bin/pdcomm-docs serve --open
```
On Windows, run bin\pdcomm-docs.exe serve --open. The default address is http://127.0.0.1:8787/; use --port to change the port.
Or open it with Python 3:
터미널 창
```
python3 -m http.server 8000 --bind 127.0.0.1 --directory site
```
On Windows, use py instead of python3. Then open http://127.0.0.1:8000/en/ in your browser.

Press Ctrl+C to stop either server. Both are reachable only from this computer (127.0.0.1).

Use the docs from AI tools

pdcomm-docs is both a docs search CLI and an MCP server. Connect it to AI tools such as Claude Code or Cursor, and they base their answers on these docs and the API reference. See Use the docs from AI tools.
The site has text files for LLMs. On the public site they are /docs/en/llms.txt and /docs/en/llms-full.txt in English, /docs/llms.txt and /docs/llms-full.txt in Korean. Every page is also available as Markdown at its address followed by .md, such as /docs/en/modbus/quickstart.md. The offline copy drops the leading /docs.