QuickApp emulator (hc3emu)

[Christb 33]

23 hours ago, jgab said:

So to read in a json file from the pc when you run in the emulator you can do

I have created this QA:

if require and not QuickApp then require('hc3emu') end

--%%name=testQA
--%%description=Test QuickApp
--%%type=com.fibaro.binarySwitch
--%%offline=true

function QuickApp:onInit()
  self:debug("welcome")
  local data
  if fibaro.hc3emu then -- We run in the emulator
    local f = fibaro.hc3emu.lua.io.open("jgabsQAs.json", "r")
    assert(f,"Couln't open the file")
    data = f:read("*a")
    f:close()
    
    if data == nil then
      self:debug("data is nil")
    else
      self:debug("data is not nil")
      print("data", data)
    data = json.decode(data)
    end
    --return data
  else -- running on HC3
    data = {}
  end
end

 

Note that I do not have any access to my HC3  working from another network.

Working but I am getting the following DEBUG message with an 'event handler error':

Process started
[23.05.2025][20:45:49][SYS] Parsing TestQA.lua directives...
[23.05.2025][20:45:50][SYS] Main QA file TestQA.lua
HC3Emu - Tiny QuickApp emulator for the Fibaro Home Center 3, v1.1.6
[23.05.2025][20:47:00][SYSERR]    Event handler error: ...apps\luarocks\current\rocks\share\lua\5.4\hc3emu\api.lua:192: attempt to call a nil value (method 'match')
[23.05.2025][20:47:00][SYS] Starting QuickApp 'testQA'
[23.05.2025][20:47:00][DEBUG ][TESTQA5001]: welcome
[23.05.2025][20:47:00][DEBUG ][TESTQA5001]: data is not nil
[23.05.2025][20:47:00][DEBUG ][TESTQA5001]: data [
  {"user":"jangabrielsson","repo":"EventRunner5","name":"EventRunner5.fqa"},
  {"user":"jangabrielsson","repo":"Dirigera","name":"Dirigera.fqa"},
  {"user":"jangabrielsson","repo":"HassQA","name":"HASS.fqa"},
  {"user":"jangabrielsson","repo":"SonosQA","name":"SonosPlayer.fqa"}
]

 

 

Edited May 23, 2025 by Christb
add a note

[jgab 2,647]

It's a bug when running in offline and when starting up. 

It tries to calculate the sunset/sunrise to use offline, but a function call was wrong.

Will fix in 1.1.9 tomorrow.

[Christb 33]

20 hours ago, jgab said:

Will fix in 1.1.9 tomorrow.

Yes I do not have any more the Event handler error but before starting the QA the emulator needs a little more than a minute, normal?

[jgab 2,647]

12 hours ago, Christb said:

Yes I do not have any more the Event handler error but before starting the QA the emulator needs a little more than a minute, normal?

No, it's not normal. Running offline or online?

If it starts up after more than a minute (as opposed to crashing), the issue must be that it takes a long time to read in data from the HC3.

It does a api.get("/devices") when starting up online.

[Christb 33]

3 hours ago, jgab said:

No, it's not normal. Running offline or online?

I am still offline using the QA I gave you the code in my previous post.

[24.05.2025][19:07:35][SYS] Main QA file TestQA.lua
HC3Emu - Tiny QuickApp emulator for the Fibaro Home Center 3, v1.1.9                                   
[24.05.2025][19:08:46][SYS] Starting QuickApp 'testQA'                                                              
[24.05.2025][19:08:46][DEBUG ][TESTQA5001]: welcome                                                            
[24.05.2025][19:08:46][DEBUG ][TESTQA5001]: data is not nil                                                   
[24.05.2025][19:08:46][DEBUG ][TESTQA5001]: data [                                                                   
  {"user":"jangabrielsson","repo":"EventRunner5","name":"EventRunner5.fqa"},            
  {"user":"jangabrielsson","repo":"Dirigera","name":"Dirigera.fqa"},                                      
  {"user":"jangabrielsson","repo":"HassQA","name":"HASS.fqa"},                                           
  {"user":"jangabrielsson","repo":"SonosQA","name":"SonosPlayer.fqa"}                            

 ]                                                                                                                                                                                  

 

I was the same long time with previous hc3emu version giving the Event handler error.

 

Do you have a way to get information of what the emulator is doing during this minute?

Edited May 25, 2025 by Christb
Add a question

[jgab 2,647]

Add this

Please login or register to see this code.

 

[jgab 2,647]

Ah, there was a miss so it tried to do 2 calls to the HC3 at startup even if offline was set.

They hang ~30s each...

 

Pushed v1.1.10 with the fix.

 

[Christb 33]

46 minutes ago, jgab said:

Ah, there was a miss

You fix it, now only 4seconds to get the result and file content print. Thanks

[jgab 2,647]

Yes, but I introduced another bug when you are online.  

Pushed v1.1.11 with a fix for that.

[jgab 2,647]

So. the last week I have been working on a alternate version of Hc3Emu.

In my quest to rewrite and simplify the emulator, I realized that I wanted the redo the core architecture (the old felt a bit "overengineered"). So instead of a normal update to the code, I started from scratch and have been lifting over features from Hc3Emu - which has worked surprisingly well due to its modularity - and allowed me to have a new emulator that is now on feature parity with the old (minus some rarely used features).

 

The new emulator is named, Fanfare 🥳, Hc3Emu2.

 

It will be installed with

Please login or register to see this code.

and it uses the same libraries like the old hc3emu. So it's a painless switch between them.

I have decided to keep them both around for a while, but all my focus is on hc3emu2 and it runs all my other projects - so that's what I'm using now. I may update the old hc3emu for glaring bugs, but I would recommend users of hc3emu to come along on the hc3emu2 ride with me.

 

From a usage perspective, they are very similar. --%% directives in the code, proxy, emulated web UI etc.

 

The major breaking changes are

• How it's launched (a new vscode launch.json, tasks.json, and for zerobrane studio there is a interpreter plugin)
• There is no need for "if require and not QuickApp then require('hc3emu') end" at the top of the file. 
• A new configuration file format (again). Back to a plain lua file and no Web UI editor for the config file (It was unmaintainable code, not worth the effort)

There are also some minor changes to some directives, that is not compatible between emulators and need to be changed in QAs. It's a good reminder what emulator you are running (can be confusing when switching between them - I know from experience this week  )

 

I will release it later this week. I will also keep it to this forum thread and start to change the documentation in the first post to reflect the usage of hc3emu2.

Eventually, when I feel confident enough that there is nothing from the old hc3emu worth keeping, I may remove it and rename hc3emu2 to just hc3emu...

 

[jgab 2,647]

I pushed a prerelease now

It will be installed with

Please login or register to see this code.

It has the version number 2.0.0 to signal that it's the second generation of hc3emu. I will still refer to the emulator as hce3mu, it's only the rock that is named hc3emu2.

 

What's missing is some of the vscode tasks that are under development as we speak...

[Łukasz997 117]

Change to a new version maybe is a good moment to fix (or clarify) the following issue probably related to HC3Emu:

When I run "Task → Upload QA", the QA is created in the HC3. QA runs as desired.

However, when I then open the QA on the HC3 and try to edit one of the "files", some fails to open – showing only:

 

Please login or register to see this image.

/monthly_2025_05/image.png.5dba827d2dcce0e3fda9b4f3a874e2e4.png" />

 

Interestingly, not all files are affected - some can be viewed/edited normally.

Restarting central, refreshing the browser or downloading the .fqa file (and reinstalling) does not solve the issue.

Moreover, trying to "Task → Update QA" (for the previously uploaded QA) leads to an error:

Please login or register to see this code.

I will be glad that so powerful tools would work fine. I can send you "affected" fqa.

[jgab 2,647]

6 hours ago, Łukasz997 said:

Change to a new version maybe is a good moment to fix (or clarify) the following issue probably related to HC3Emu:

When I run "Task → Upload QA", the QA is created in the HC3. QA runs as desired.

However, when I then open the QA on the HC3 and try to edit one of the "files", some fails to open – showing only:

 

Please login or register to see this link.

 

Interestingly, not all files are affected - some can be viewed/edited normally.

Restarting central, refreshing the browser or downloading the .fqa file (and reinstalling) does not solve the issue.

Moreover, trying to "Task → Update QA" (for the previously uploaded QA) leads to an error:

Please login or register to see this code.

I will be glad that so powerful tools would work fine. I can send you "affected" fqa.

 

Yes, please send me the fqa. 

[jgab 2,647]

7 hours ago, Łukasz997 said:

Moreover, trying to "Task → Update QA" (for the previously uploaded QA) leads to an error:

Please login or register to see this code.

I will be glad that so powerful tools would work fine. I can send you "affected" fqa.

 

So, looking at the error, it seems like it is trying to create (do a POST command) the QA file 'main'

which is an error. 'main' should always exists and we can't create a new 'main' with 'POST', thus the 'Error: creating QA:736'

 

So, the question is why it tries to upload a QA without 'main' - that seems to be a bug, I haven't seen before with other QAs...

Would be nice if you could gzip together the development files for the QA so I can try to reproduce it. The fqa is probably already

damaged so it can be difficult to understand why - but please send that too.

 

So, this does not really explain the 501 error. I wonder if it is that you name the QA files with some strange names?

(the names they get on the HC3). The HC3 is pretty restrictive on the names, no spaces, not too short, not too long.

I don't have any sanity check on it currently.

 

quick test, the names seems to have to be 3-20 characters long, and only contain alphanumeric characters and underscore.

hc3emu2 makes that check now.

Edited May 28, 2025 by jgab

[Łukasz997 117]

Good morning Jan,

please find included the example - fqa created from quick app that suffers from above phenomenon and 2 lua files consisting of this fqa. Names are original. File named on HC3 HTMLTablesLC cannot be displayed, second - named main, can be. 

Please login or register to see this attachment.

[jgab 2,647]

Yes, you have a space before the name

Please login or register to see this code.

and it's because you do 

Please login or register to see this code.

and I take everything after the comma as the name.

So the HC3 accepts importing a bad filename but crashes when trying to open it...

hc3emu2 makes a sanity check of the filename before making an fqa for upload.

[Łukasz997 117]

Thank you - I had no idea it was that strict.
I've checked and all is editable now.

 

However, this does not change non-functioning update. Still got error.
 

Please login or register to see this code.

 

Edited May 28, 2025 by Łukasz997

[jgab 2,647]

Are you sure that the the QA on the HC3 has deviceId 736?

[jgab 2,647]

I'm running your QA and can update the file

Please login or register to see this code.

 

[Łukasz997 117]

51 minut temu, jgab napisał:

Are you sure that the the QA on the HC3 has deviceId 736?

ID is not 736, but historically it was. Now is 745 in HC3 and in lua file. But update still refers to old 736 ID, I have no idea why - I can't find a place in my files where 736 is used. These are the directives:

Please login or register to see this code.

The path was the following, maybe it will help: 
--%%id=736 this was first

then task->upload, 736 was not available, 745 "automatically" was assumed as first free slot

--%%id=745 I made correction in lua file, save

task->update still refers to 736 and ends with error.