On this page
SAM identity-card reader
Resident ID card security module card search, card selection and explicit card reading driver
Open the plugin
Enter “Development Configuration → Collection Configuration”, create a device and select “SamCardMaster” in “Collection Plugin”.
Supported channels and data types
| Channel type | Pre-configuration check |
|---|---|
| Serial Port | Confirm that the serial port is not occupied by other programs and maintains the same baud rate, data bits, stop bits and parity bits as the device. |
| TCP Client | Confirm network reachability of the device IP, port, and gateway to the device. |
Optional data types: Select by page options
Address rules
- The SAM ID card security module does not support register variable addresses. Please perform the complete card reading process by reading the module number, checking the module status, finding the card, selecting the card and reading the card dynamically.
Special methods
| Method | Purpose | Parameters |
|---|---|---|
| ReadModuleNumberAsync | Read the security module number | No parameters |
| CheckModuleStatusAsync | Check security module status | No parameters |
| SearchCardAsync | Search ID card | No parameters |
| SelectCardAsync | Select ID card | No parameters |
| ReadCardAsync | Read ID card | No parameters |
Device debug
Enter “Development Configuration → Collection Configuration”, select the current device then open “Protocol Debug” at the top of the workspace.

Debugging notes
Card searching, card selection, and reading summaries may display identity information and require sensitive data permissions and secondary confirmation.
Functions
| Function | Purpose |
|---|---|
| Read or monitor | Read current values or monitor the latest device update. |
| Read or monitor | Read current values or monitor the latest device update. |
| Search card | Use Search card and review the returned result. |
| Select card | Use Select card and review the returned result. |
| Read card | Use Read card to inspect mapped values, status, counters, recent messages, or the latest result. |
Verify the configuration
Match the module number to the reader label or confirm the status query; use Search → Select → Read for the separate card workflow.
Writes and control operations require an approved test point and the site safety procedure.
Troubleshooting
- Ordinary register variables do not apply. If module status is healthy but card reads fail, check placement and Search/Select order.
- Special method execution fails: Check method parameters and permissions; control, write or reset methods also need to confirm that the device is in a state that allows operation.
- The serial port device does not respond: Confirm that the serial port is not occupied, and check the baud rate, data bits, stop bits and parity bits.
Related links
- Collection configuration: View channel, device and common variable configuration.
- Plugin Index: Find other collection or data-forward plugins.