Docs Menu & SOP Browser¶
The Docs button appears in the top-left of every machine detail page. It provides quick access to reference documents for the machine. Clicking it opens a small dropdown menu listing available document types.
Note
The Docs menu is available on all machines. For non-VFD machines the menu is currently empty and will be populated as additional document types (datasheets, design documents, maintenance registers) are introduced.
Standard SOPs¶
For VFD machines, the menu contains a Standard SOPs entry. Clicking it opens a full-height panel showing the complete SOP library for the drive.
Browsing SOPs¶
Use the word-type pills at the top of the panel to switch between:
- Alarm Word
- Alarm Word 2
- Warning Word
- Warning Word 2
- Extended Status Word
- Maintenance Word
- Status Word
The list below the pills shows every alarm or flag defined for the selected word type.
Reading an SOP row¶
Each row shows the alarm name, alarm code, bit position, and a source badge:
| Badge | Meaning |
|---|---|
| Custom | Your organisation has defined a specific SOP for this alarm |
| Default | The manufacturer's standard troubleshooting steps are available |
| No SOP | No steps are defined for this alarm yet |
Click any row with a Custom or Default badge to expand the SOP steps inline. Each step may include a caution note highlighted in amber. If the SOP has an attached document, a link to it appears at the bottom.
Relationship to active-alarm SOPs¶
The SOP browser shows the full catalog for the drive — all defined alarms, whether currently active or not. The SOP button on each active condition in the dashboard opens the same content for that specific alarm, without needing to browse to it manually.