[Question] Change VD Name by LUA/API

[FSE 34]

I wonder if there is a way to change the name of VD using LUA or API calls. I see it well documented to change a label but I can not find an example to change the name of the VD. Any example would be helpful!

 

[drboss 107]

First look http://HC2IP/docs and 

 many other tutorials on forum.fibaro.com

 

1. use API.GET function for take data for VD (ex. vd_section = api.get('/devices/988')["properties"]["rows"] or vd_full = api.get('/devices/988')) depends of your LUA code and method of access and edit vd data.

2. edit name of label for change (ex. edited_data = vd_section.elements[1].caption = 'new text') or edited_data = vd_full.rows[1].elements[1].caption = 'new text')  --for chose correct row and element number look the vd code by .../docs or use code like below (this for button but for label is similar) 

Please login or register to see this code.

 

3. use API.PUT for store new value (ex. return = api.put('/devices/988', edited_data) or simular

But remember for effect you need to refresh web browser or retake all data for HC2 on mobile app.

 

[FSE 34]

@drboss thank you for your answer. I try to change the name of VD by itself and not a label/button that is included on the VD. 

The reason I need this because I have VDs that are controlled by other applications, so if I change the name of a plug from native application, I like to get the same name on fibaro without change it by hand. 

[drboss 107]

sorry, my mistake. It's night  I read that You have change the name of labels in VD not VD name.

For change VD name is mach easy. The same method.

Ex. from any external HTTP REST client use PUT http://HC2IP/api/devices/48 {"name": "Zmywarka"} of course with username and password but from  LUA (any VD) use: 

pload = api.put('/devices/48', '{"name": "New name"}')

fibaro:debug(pload)

 

or

name = 'new name'

id = '48'

pname = '"name":"'..name..'"}'

pload = api.put('/devices/'..id, pname)

[FSE 34]

@drboss thank you! you make it so simple! I m on learning period so many questions are stupid. Thanks again!

22 minutes ago, drboss said:

sorry, my mistake. It's night  I read that You have change the name of labels in VD not VD name.

For change VD name is mach easy. The same method.

Ex. from any external HTTP REST client use PUT http://HC2IP/api/devices/48 {"name": "Zmywarka"} of course with username and password but from  LUA (any VD) use: 

pload = api.put('/devices/48', '{"name": "New name"}')

fibaro:debug(pload)

 

or

name = 'new name'

id = '48'

pname = '"name":"'..name..'"}'

pload = api.put('/devices/'..id, pname)

I tested but it did not worked

I try to rename the VD that code is included but no change on the name done. No errors returned

[drboss 107]

There's no such thing as a stupid question. 

, only the answer can be a stupid

... we say in Poland 

 

The forum is for ask and learn for all as. 

 

 

 

[FSE 34]

12 minutes ago, drboss said:

There's no such thing as a stupid question. 

, only the answer can be a stupid

... we say in Poland 

 

The forum is for ask and learn for all as. 

 

 

 

 

you are right! I tried to search answer first but it was not found. Could you please confirm your code? It looks like it did not renamed VD

I also placed on a scene using both methods as below. What I miss? I just want to edit the name of VD, not to create a new one. Also on docs there is no api.put but there is api.post

 

pload = api.put('/devices/48', '{"name": "New name"}')

fibaro:debug(pload)

 

or

name = 'new name'

id = '48'

pname = '"name":"'..name..'"}'

pload = api.put('/devices/'..id, pname)

[drboss 107]

I will check on my hc2 afternoon. 

[drboss 107]

working code for change name of any device:

Please login or register to see this code.

 

[FSE 34]

55 minutes ago, drboss said:

working code for change name of any device:

Please login or register to see this code.

 

tested once again...which version do you have installed? mine is 4.510 and It did not rename VD

[drboss 107]

i tested on 4.510 but on normal device, it's crease but not work with VD. Interesting I will check in the moment.

ok I find for VD is another API command for write and read, for read work two, but for write only dedicated. Below code for Virtual Devices, the code before is for Device.

 

Please login or register to see this code.

 

Edited September 4, 2018 by drboss

[FSE 34]

I also confirm that on a normal device is change name. Still VD do not get this change!!!!

---Deleted---

Someone PLEASE UPDATE LUA/API Documentation!

Edited September 4, 2018 by korniza

[drboss 107]

but with this line work?

Please login or register to see this code.

in my test system works fine, the name of VD was changed

Edited September 4, 2018 by drboss

[FSE 34]

Just now, drboss said:

but with this line work?

Please login or register to see this code.

Yes Sir!

it is working....! Where did you find all these api calls?

2 minutes ago, drboss said:

but with this line work?

Please login or register to see this code.

in my test system works fine, the name of VD was changed

Yes Sir! It works! Where did you find all these API calls? Official documentation has gaps.

[drboss 107]

combination of /docs, forum, checking rest command in web browser sending by hc2 web page when I push save bottom and medium knowledge of LUA and JSON 

 

 

if you have any other questions, write to the forum. I often look here. But there are really many better professionals here who also help.
I learned a lot here

Edited September 4, 2018 by drboss

[FSE 34]

IMHO it is a way not just to change just names BUT you can add some info on the name of VD according to status (online/offline, enabled/disabled, Off/On, armed/disarmed etc) or even values.

 

[drboss 107]

problem is limit of character in name of VD displayed in mobile app (you need check this). it's no problem 

Please login or register to see this code.