HC3 LUA vs HC2

[knuth 28]

In making the transfer from HC2 to HC3 based on a cloud backup (update 4.581 Beta) it is stated that "scenes will not be moved and need to be created again". That's OK, but it would be helpful when planning the transfer to know what the differences are (in syntax and available functions) between the two LUA versions. I know that the new LUA editor is documented in 

Please login or register to see this link.

 . What I would hope to see in addition, is a side by side comparison of all the crucial differences, to enable a pre-edit of the old LUA scenes before entering them into the new editor. Something like this:

 

If you used this in HC2 LUA:                You need to do this in HC3 LUA:

fibaro.debug("txt")                                   fibaro.debug("tag", "txt")

os.time()                                                   ??? 

etc.

 

If we all contribute to such a table as we identify all the differences, we may be able to help each other prepare for HC3. Not all differences can easily be summarized in the simple two-column format above, however. For the new definition of conditions and triggers, it seems it would be more appropriate to give a few examples of old codes (with triggers) converted to new codes. 

 

PS: I haven't even decided to buy the HC3 yet! But getting a feel for the amount of re-programming needed to convert my scene is an important factor in making that decision. 

 

The suggested table is now shown in a pdf file attached to this post, see below. It is regularly updated as new contributions are posted.

Please login or register to see this attachment.

Edited May 12, 2020 by knuth
Moved summary table to first post

[Guest kallecux]

Hi @cag014 your hint was the right hint! 

 

But i get:

 

devices=fibaro.getDevicesID({visible = true, enabled = true}) 

 

[ERROR] 10.03.2020 13:28:39: (load):11: attempt to call a nil value (field 'getDevicesID')

 

Greetings!

[jgab 1,950]

15 minutes ago, parip69 said:

With which command can I find out which profile is active

print( api.get("/profiles").activeProfile)

[cag014 628]

Everything is try and error...

for example

HC2 -fibaro:getDevicesId

HC3 - fibaro.getDevicesID

No idea why Fibaro change suffix Id to ID. It took me 15 minutes to identify  the difference. (beside the change colon ":" to period ".")

and more others...

Edited March 10, 2020 by cag014

[cag014 628]

Wow... you're correct.

It works in QuickApp, but not in scene!?

Have reported to Fibaro

Edited March 10, 2020 by cag014

[knuth 28]

Thanks for sharing, @cag014 . Your two examples ("ID" and colon->period) are precisely the type of changes that are easily overlooked when preparing a conversion. I collect such examples in a table off-line, and will share the result when more contributions are in. Please keep them coming, users, as you discover the subtle differences between HC2 and HC3 LUA. 

[cag014 628]

Please add

HC2

fibaro:startScene(id,{args}) 

HC3

fibaro.scene("execute",{id,id})

no arguments anymore

[knuth 28]

First version of summary table, including some that are not mentioned above. I am sure there is more, please post your contribution once you find other differences.

The trigger section is still empty, ready to receive examples of old -> new code. 

Edit: The summary table is now attached to my first post

 

 

 

 

 

Edited May 12, 2020 by knuth
Moved summary table to first post

[Repe 1]

This already helped me with zipato rfid reader. Big thanks.

[MARCUSP.I.L 16]

Sorry to say i have an inclusion that is not exactly positive:

 

HC2 LUA      fibaro: after 3 years work :good                                              

HC3 LUA     fibaro: not a finished product: negative                                                         

Comment     Feels like a giant step backwards, devices not recognized , relearning process and coding , backup scenes not     transferable. Released way too soon.

 

I admire your tenacity and work improving the functions of hc3 , but it seems fibaro are asking the community to finish their product, yet again.

Will pass on HC3 until it recieves major updates.

        

            

Edited March 15, 2020 by MARCUSP.I.L

[cag014 628]

@knuth

Please update file

fibaro:getGlobalModificationTime() not supported in HC3

[jgab 1,950]

25 minutes ago, cag014 said:

@knuth

Please update file

fibaro:getGlobalModificationTime() not supported in HC3

Maybe a column with ways to achieve the same functionality?

Please login or register to see this code.

 

[knuth 28]

I will have to trust you on this one, @jgab , as I do not know the "select" function and how it works. Your suggestion will indeed be included in my "HC3 LUA" column as a solution. The file will be updated very soon.

[jgab 1,950]

30 minutes ago, knuth said:

I will have to trust you on this one, @jgab , as I do not know the "select" function and how it works. Your suggestion will indeed be included in my "HC3 LUA" column as a solution. The file will be updated very soon.

So fibaro.getGlobalVariable(var) returns 2 values. The value of the var and the modification time. Like fibaro.get.

Please login or register to see this code.

You don't need to define fibaro.getGlobalModificationTime(var)

It's as easy to do as in the example above or just use it direct in expressions

Please login or register to see this code.

select(n,...)  is a standard Lua function that selects the remaining 'n' values of the argument '...' (it's a surprisingly useful function...)

It may seem a bit wasteful to retrieve the value to just get the modification time. 

However, I believe in the HC2 Lua API they get the whole variable data structure and return just the modified key so this is very little overhead.

[jgab 1,950]

Another subtlety that may surprise people.

In HC2 

Please login or register to see this code.

In HC3 (scene)

Please login or register to see this code.

 

Edited March 16, 2020 by jgab

[knuth 28]

19 hours ago, jgab said:

Another subtlety that may surprise people.

Subtle, indeed, and maybe beyond the simple tabulation that I try to put together. Besides, this looks like a bug, since the json.encode should work the same in both versions.

 

Thanks for putting me straight on the Global Variable update time issue. To convert your last post to my two-column format, it seems I could just write:

HC2 LUA                                                                      HC3 LUA

fibaro:getGlobalModificationTime()                       select(2,fibaro.getGlobalVariable(var))

 

If you confirm (or correct), I can insert this in my pdf table.

[cag014 628]

3 hours ago, knuth said:

Subtle, indeed, and maybe beyond the simple tabulation that I try to put together. Besides, this looks like a bug, since the json.encode should work the same in both versions.

 

Thanks for putting me straight on the Global Variable update time issue. To convert your last post to my two-column format, it seems I could just write:

HC2 LUA                                                                      HC3 LUA

fibaro:getGlobalModificationTime()                       select(2,fibaro.getGlobalVariable(var))

 

If you confirm (or correct), I can insert this in my pdf table.

Confirmed... works fine

[knuth 28]

Updated pdf file, see March 11 post above. 

[jgab 1,950]

HC2:

fibaro:isSceneEnabled(sceneID)

fibaro:setSceneEnabled(sceneID , enabled)

fibaro:getSceneRunConfig(sceneID)

fibaro:setSceneRunConfig(sceneID ,runConfig)

 

HC3:

function fibaro.isSceneEnabled(sceneID) return api.get("scenes/"..sceneID).enabled end

function fibaro.setSceneEnabled(sceneID,enabled) return api.put("scenes/"..sceneID,{enabled=enabled}) end

function getSceneRunConfig(sceneID) return api.get("scenes/"..sceneID).mode end

function setSceneRunConfig(sceneID,runConfig) return api.put("scenes/"..sceneID,{mode=runConfig}) end -- mode is 'automatic' or 'manual'

[jgab 1,950]

Other missing functions in HC3 scenes

Please login or register to see this code.

 

[boomx 43]

Does anyone know how to control the RGBW controllers via LUA? I've already tried everything. For me only goes on / off ...