Jump to content

Welcome to Smart Home Forum by FIBARO

Dear Guest,

 

as you can notice parts of Smart Home Forum by FIBARO is not available for you. You have to register in order to view all content and post in our community. Don't worry! Registration is a simple free process that requires minimal information for you to sign up. Become a part of of Smart Home Forum by FIBARO by creating an account.

 

As a member you can:

  •     Start new topics and reply to others
  •     Follow topics and users to get email updates
  •     Get your own profile page and make new friends
  •     Send personal messages
  •     ... and learn a lot about our system!

 

Regards,

Smart Home Forum by FIBARO Team


The documentation of the current status of the programs created in HC3. 2022/10/15


precioz
 Share

Recommended Posts

I'm asking the forum for support regarding the creation of software documentation in HC3.

(please answer yes/no)


I propose to create a button in the /app/settings/general/main location, which would make a documentation in the text format as similar as possible (included a graphical side) to the HC3 programming area in LUA scenes.
The file name should be DocFIBYYYYMMDDTime.LUA. It would be used for comparison with older versions of the software in Visual Studio Code (Microsoft).

I really
appreciate the HC3 system. However, my customers and I lack a documentation of all scenes in the text format in one file. This collection would allow me and my customers to rewiev the previous data to remind ourselves the original state of the software and settings. When our system doesn't work, I would like to find what I have changed before or what have gone wrong. By comparing the original documentation with the new one, I would have an immediate overview. Furthermore, this documentation could be useful to search for the ID numbers in the scenes.
As you probably know, sometimes we are forced to remove and add the ID again. This
causes the ID to be renumbered. As a result of it, it is necessary to replace the old ID numerical codes with the new ones in all scenes. When renumbering the ID of, for example a three-phase electricity meter, it has to make 32 times.
The structure of
the documentation is described in the "BLOCK Scheme" below.
An example of
the documentation is given in the "Example of documentation" below.

Experts may program in other languages and make extensive use of APIs, but the system is not intended for them, but for the general public. The public needs outputs perhaps more than experts.

I w
ould be grateful if FIBARO looked into this as soon as possible.

With thanks for your cooperation     ing. Petr Boltík

 

 

"BLOCK Scheme the documentation"

procedure CreateTXT(DocFIBYYYYMMDDTime.LUA);

var i,sceneMAX: Integer;

BlockScene: boolean;

begin

 for i := 1 to SceneMAX do --the main passage

 if exists(scene[i]) then

 begin

  if BlockScene then TraslateBlockToLUA;

  SaveNumber and NameScene;

  Save DECLARATIONS (Conditions/Triggers) scene;

  Save "---------------------------------";

  Save ACTIONS scene;

 end;

 

 for i := 1 to QuickUPMAX do --passage QuickUp

 if exists(QuickUP[i]) then

 begin

  SaveNumber and NameQuickUP;

  SaveDevice???

  SaveMain;

 end; 

 for i := 1 to rowDocumentTXTMAX do --passage control on exist ID and SC

 begin

  if search ID (not exists in systém HC3) then

  begin

   changetxt "IDXXX" on IDXXXNotexists or IDXXXERROR

  end;

  if search Scene( not exists in systém HC3) then

  begin

   changetxt "SCXXX" on SCXXXNotexists or SCXXXERROR

  end;

 end;

 

 for i := 1 to IDMAX do --passage ADD params ID

 begin

  SaveNumber and NameID;

  Save name Params and value;

 end;

end;

 

"Example of documentation":

--SC46 on device >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

table = {

  isTrigger = true,

  operator = "match",

  property = "cron",

  type = "date",

  value = { "0", "*", "*", "*", "*", "*" }

}

--------------------------------------------------

local currentHod = os.date("*t").hour

hub.call(467NOTEXIST, "turnOff")

hub.call(468, "turnOff")

hub.call(469, "turnOff")

hub.call(470, "turnOff")

if (currentHod == 0) then

  --hub.call(470, "turnOn") --zahrada vzadu

elseif (currentHod == 1) then

  hub.call(467NOTEXIST, "turnOn")

elseif (currentHod == 2) then

  hub.call(469, "turnOn")

elseif (currentHod == 12) then

  hub.call(470, "turnOn")

end

 

--SC47 off device >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

table = {

  isTrigger = true,

  operator = "match",

  property = "cron",

  type = "date",

  value = { "0", "*", "*", "*", "*", "*" }

}

--------------------------------------------------

--local currentHod = os.date("*t").hour

hub.call(467NOTEXIST, "turnOff")

hub.call(468, "turnOff")

hub.call(469, "turnOff")

hub.call(470, "turnOff")

 

--SC48 on device >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

...

 

 

  • Thanks 1
Link to comment
Share on other sites

  • Topic Author
  • Ticket ID: 226025
    Ticket: Petr Boltík
    _______________________________
     
    Hello, 
     
    Thank you for the message!
     
    We appreciate your involvement in improving our systems.
     
    Thank you for the precise suggestions, I already redirected them to our RnD department :)
     
    Pozdrawiam/Kind regards,

    Kacper Klensporf
    Tech Support

    Please login or register to see this link.

     
    +48 618 801 000 
    +44 845 154 2852 
    +33 970 733 545 


    smart-home-system.png
    Link to comment
    Share on other sites

    Join the conversation

    You can post now and register later. If you have an account, sign in now to post with your account.

    Guest
    Reply to this topic...

    ×   Pasted as rich text.   Paste as plain text instead

      Only 75 emoji are allowed.

    ×   Your link has been automatically embedded.   Display as a link instead

    ×   Your previous content has been restored.   Clear editor

    ×   You cannot paste images directly. Upload or insert images from URL.

     Share

    ×
    ×
    • Create New...