Difference between revisions of "Component: Property Manager (Storage )"

From Flowcode Help
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==Property Manager component==
 
==Property Manager component==
 
Allows property values exposed to the user to be saved and loaded using an external file. Simplifies the process of storing and retreiving the property values. Also works with nested properties using the "::" syntax.
 
Allows property values exposed to the user to be saved and loaded using an external file. Simplifies the process of storing and retreiving the property values. Also works with nested properties using the "::" syntax.
 +
 +
==Component Pack==
 +
 +
FREE
  
 
==Detailed description==
 
==Detailed description==
  
−
''No detailed description exists yet for this component''
 
  
−
==Examples==
 
  
  
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Save'''
 
−
|-
 
−
| colspan="2" | Saves the registered property values to the config file.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Load'''
 
−
|-
 
−
| colspan="2" | Loads the registered property values from the config file.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
''No detailed description exists yet for this component''
−
|-
+
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+
==Examples==
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterProperty'''
+
 
−
|-
 
−
| colspan="2" | Registers a property to be saved or loaded&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | PropertyVariable
 
−
|-
 
−
| colspan="2" | Property variable exposed to the user, highlight property and variable is shown at the bottom of the window.&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearBuffer'''
 
−
|-
 
−
| colspan="2" | Erases the contents of the buffer&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDigitalInputs'''
 
−
|-
 
−
| colspan="2" | Reads the state of up to eight digital inputs. Can pack a max of 8-bits together in a single operation&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | StartAddress
 
−
|-
 
−
| colspan="2" | Coil Address Range 0 to (NumCoils - 1)&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | AddressCount
 
−
|-
 
−
| colspan="2" | Range 1-8&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLastIncoming'''
 
−
|-
 
−
| colspan="2" | Gets a value from the last incoming command. Index 0 = 0 Read / 1 Write Index 1 = 0 Coils / 1 DigInput / 2 AnInput / 3 Register Index 2 = Address  Index 3 = Number&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAnalogInput'''
 
−
|-
 
−
| colspan="2" | Sets the state of a single analogue input.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | Coil Address&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Value
 
−
|-
 
−
| colspan="2" | Analogue Value range 0 - 65535&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | Starts up the UART to allow communications and initialises the states of the various  Modbus Coils, Inputs and Registers to 0.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AppendStringToFile'''
 
−
|-
 
−
| colspan="2" | Adds the contents of the data string parameter to the end of the currently open file. Returns 0 for success.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | Data_String
 
−
|-
 
−
| colspan="2" | Data to append to the end of the file&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
 +
==Downloadable macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFileSize'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Save'''
 
|-
 
|-
−
| colspan="2" | Reads the entire size of the current file in bytes.&nbsp;
+
| colspan="2" | Saves the registered property values to the config file.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 190: Line 67:
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTimeAndDate'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Load'''
 
|-
 
|-
−
| colspan="2" | Sets the current time and date.  Time = (Hour << 11) + (Min << 5) + (Sec >> 1) Date = (YearFrom1980 << 9) + (Month << 5) + (Day) Additional details can be found here: http://www.maverick-os.dk/FileSystemFormats/FAT16_FileSystem.html#TimeFormat&nbsp;
+
| colspan="2" | Loads the registered property values from the config file.&nbsp;
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Time
 
−
|-
 
−
| colspan="2" | Sets the current Time in FAT Time format hhhhhmmmmmmsssss - S=Secs/2&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Date
 
 
|-
 
|-
−
| colspan="2" | Sets the current Date in FAT Date format yyyyyyymmmmddddd - Y=Years since 1980&nbsp;
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 213: Line 80:
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterProperty'''
 
|-
 
|-
−
| colspan="2" | Attempts to communicate with the SD card and if successful sets up the file system. Returns 0 for success. &nbsp;
+
| colspan="2" | Registers a property to be saved or loaded&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
+
| width="90%" | PropertyVariable
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent.&nbsp;
 
 
|-
 
|-
 +
| colspan="2" | Property variable exposed to the user, highlight property and variable is shown at the bottom of the window.&nbsp;
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 265: Line 124:
 
|-
 
|-
 
| colspan="2" | Forces the user to check if they are sure before overwriting previous values.&nbsp;
 
| colspan="2" | Forces the user to check if they are sure before overwriting previous values.&nbsp;
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 
−
|-
 
 
|}
 
|}

Latest revision as of 17:22, 9 November 2022

Author Matrix TSL
Version 1.0
Category Storage


Property Manager component

Allows property values exposed to the user to be saved and loaded using an external file. Simplifies the process of storing and retreiving the property values. Also works with nested properties using the "::" syntax.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png Save
Saves the registered property values to the config file. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Load
Loads the registered property values from the config file. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RegisterProperty
Registers a property to be saved or loaded 
Fc9-string-icon.png - STRING PropertyVariable
Property variable exposed to the user, highlight property and variable is shown at the bottom of the window. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-20-icon.png Filepath
Sets the path of the file to write to. $(srcdir) default sets the path to be the same as the Flowcode project path. 
Fc9-type-10-icon.png Filename
 
Fc9-type-7-icon.png Show Dialogue On Load
Forces the user to check if they are sure before loading saved values. 
Fc9-type-7-icon.png Show Dialogue On Save
Forces the user to check if they are sure before overwriting previous values. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Property_Manager_(Storage_)&oldid=28730"