Macro reference manual not loading when Agent behind a proxy

[frankbenoit]

I installed 8.0.1.
When I edit a macro, the drawer on the right "smart macro reference" keeps showing "loading..."

[ert78gb]

Please provide some information about your operation system. And could you attach the logs?

You can find it in the following path
• on Linux: ~/.config/uhk-agent/uhk-agent.log
• on macOS: ~/Library/Logs/uhk-agent/uhk-agent.log
• on Windows: %USERPROFILE%\AppData\Roaming\uhk-agent/uhk-agent.log

[frankbenoit]

I am on Windows 11,

the log, shows

**[2025-12-14 17:50:42.605] [info]  [SmartMacroDocRendererService] downloadDocumentation**
[2025-12-14 17:50:42.606] [info]  [DeviceOperation] status buffer segment: 
[2025-12-14 17:50:42.614] [info]  [DeviceRendererService] dispatch action [device] Status buffer changed
[2025-12-14 17:50:44.315] [info]  [MacroCommandEditorComponent] editor initialized.
[2025-12-14 17:50:44.330] [info]  [MacroCommandEditorComponent] fonts ready re-measure fonts.
[2025-12-14 17:51:53.121] [info]  [MacroCommandEditorComponent] editor initialized.
[2025-12-14 17:51:53.131] [info]  [MacroCommandEditorComponent] fonts ready re-measure fonts.

Afterwards nothing happens if I do not do other actions

[ert78gb]

Do you collected the electron renderer logs open the developer tools. Or did you copied it from the log files? The log files contain the every log entries. The relevant log entries start with [SmartMacroService] prefix

[frankbenoit]

it is from the log
I erased the content now and restarted, here are those with [Smart...

[2025-12-14 19:26:01.450] [info]  [SmartMacroService] starting...
[2025-12-14 19:26:01.450] [info]  [SmartMacroCopy] start
[2025-12-14 19:26:01.468] [info]  [SmartMacroCopy] copy {
  destination: 'C:\\Users\\x\\AppData\\Roaming\\uhk-agent\\smart-macro-docs\\UltimateHackingKeyboard\\firmware\\v15.3.0',
  smartMacroDocFirmwarePath: 'C:\\Users\\x\\AppData\\Local\\Programs\\UHK Agent\\resources\\packages\\firmware\\doc'
}
[2025-12-14 19:26:01.500] [info]  [SmartMacroCopy] done
[2025-12-14 19:26:01.500] [info]  [SmartMacroCopy] start copy loading.html
[2025-12-14 19:26:01.503] [info]  [SmartMacroCopy] end copy loading.html
[2025-12-14 19:26:01.503] [info]  [SmartMacroService] get free TCP port
[2025-12-14 19:26:01.510] [info]  [SmartMacroService] acquired TCP port: 54541
[2025-12-14 19:26:01.532] [info]  [SmartMacroService] started on 54541.
[2025-12-14 19:26:01.952] [info]  [SmartMacroDocRendererService] init success
[2025-12-14 19:26:01.954] [info]  Renderer appStart effect start
[2025-12-14 19:26:01.955] [info]  [SmartMacroService] getAppStartInfo

[2025-12-14 19:26:02.486] [info]  [SmartMacroDocRendererService] downloadDocumentation
[2025-12-14 19:26:02.486] [info]  [SmartMacroService] start downloading firmware documentation {
  firmwareGitRepo: 'UltimateHackingKeyboard/firmware',
  firmwareGitTag: 'v15.3.1'
}
[2025-12-14 19:26:02.487] [info]  [SmartMacroService] firmware documentation downloading

[2025-12-14 19:26:04.018] [info]  [SmartMacroDocRendererService] downloadDocumentation

[ert78gb]

Agent tries to download the firmware documentation from the github. I don't see any error in the logs. Do you have any firewall that blocks the communication? Or anything that does not block but make very slow the download?

The are 2 workarounds:

• run the firmware upgrade because the firmware tarball contains the documentation it will available on this computer too.
• copy the content from https://github.com/UltimateHackingKeyboard/firmware/tree/v15.3.1/doc/dist to C:\\Users\\x\\AppData\\Roaming\\uhk-agent\\smart-macro-docs\\UltimateHackingKeyboard\\firmware\\v15.3.1 folder

I think the doc is not available on your computer because you upgraded the firmware on other computer

[frankbenoit]

The workaround helped. So for me it is fine now. Close ticket?
I am having a cooperate firewall, hence I would suggest 2 improvements:

1. have an error message or at least logging that gives clear indicators for that problem
2. have a preference setting to set a proxy with host/port/auth

[ert78gb]

have an error message or at least logging that gives clear indicators for that problem

Agent did not get any error as far as I see in the logs that you attached. Agent just waiting for the answer or the connection to the server.

have a preference setting to set a proxy with host/port/auth

It is a good idea. Please keep the issue open. I rename the title to identify the issue more easily