Difference between revisions of "Component: String Translator (Storage)"

From Flowcode Help
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
A simple component to allow multiple language support by substituting different strings depending on the selected language.
 
A simple component to allow multiple language support by substituting different strings depending on the selected language.
  
−
==Detailed description==
+
==Component Pack==
  
−
''No detailed description exists yet for this component''
+
STORAGE
  
−
==Examples==
+
==Detailed description==
  
  
  
−
Simple example showing how to use the translation component when designing multi-language user interfaces.
 
  
−
{{Fcfile|Translations.fcfx|Translations Demo}}
 
  
  
−
Clicking the buttons on the keypad selects the active language.
 
  
−
1=English
 
  
−
2=French
 
  
−
3=German
 
  
−
==Downloadable macro reference==
 
  
−
{| 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]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTranslation'''
 
−
|-
 
−
| colspan="2" | Gets the current translated version of the string 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Language
 
−
|-
 
−
| colspan="2" | Range 0 - 7, 0=Default language 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
 +
==Examples==
  
−
{| 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;" | '''ReadInt'''
 
−
|-
 
−
| colspan="2" | Reads a 16-bit int value starting from the specified address. A 16-bit int will consume 2 bytes which will be 2 locations on an 8-bit device or 1 location on a 16-bit device. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | StartAddress
 
−
|-
 
−
| colspan="2" | Initial EE location to start reading 
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | MSBFirst
 
−
|-
 
−
| colspan="2" | 0=LSB First, 1=MSB First 
 
−
|-
 
−
| 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;" | '''ReadFloat'''
 
−
|-
 
−
| colspan="2" | Reads a 32-bit float value starting from the specified address. A 32-bit float will consume 4 bytes which will be 4 locations on an 8-bit device or 2 locations on a 16-bit device. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | StartAddress
 
−
|-
 
−
| colspan="2" | Initial EE location to start reading 
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | MSBFirst
 
−
|-
 
−
| colspan="2" | 0=LSB First, 1=MSB First 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 
−
| 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;" | '''WriteByte'''
 
−
|-
 
−
| colspan="2" | Writes a 8-bit byte value to the specified address. A 8-bit byte will consume 1 bytes which will be 1 locations on an 8-bit device or half a location on a 16-bit device. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | ByteAddress
 
−
|-
 
−
| colspan="2" | Byte address, EEADDR on 8-bit device or EEADDR/2 on a 16-bit device 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Value
 
−
|-
 
−
| colspan="2" | Floating point value to write 
 
−
|-
 
−
| 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;" | '''WriteInt'''
 
−
|-
 
−
| colspan="2" | Writes a 16-bit int value starting at the specified address. A 16-bit int will consume 2 bytes which will be 2 locations on an 8-bit device or 1 location on a 16-bit device. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | StartAddress
 
−
|-
 
−
| colspan="2" | Initial EE location to start reading 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Value
 
−
|-
 
−
| colspan="2" | Floating point value to write 
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | MSBFirst
 
−
|-
 
−
| colspan="2" | 0=LSB First, 1=MSB First 
 
−
|-
 
−
| 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;" | '''ReadString'''
 
−
|-
 
−
| colspan="2" | Reads a string of data from the EE memory starting at the specified address. 8-bit EE memory stores a character into each memory location. 16-bit EE memory stores two characters into each memory location. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | StartAddress
 
−
|-
 
−
| colspan="2" | EE Address of the first character in the string 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | MaxChars
 
−
|-
 
−
| colspan="2" | The maximum number of characters to try and read plus null termination 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
−
| 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;" | '''Read'''
 
−
|-
 
−
| colspan="2" | Reads a packet of bits from the EEPROM The number of bits read is 8 or 16, depending on the platform  
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | The address, in elements, to read the data from 
 
−
|-
 
−
| 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;"
+
Simple example showing how to use the translation component when designing multi-language user interfaces.
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadLong'''
 
−
|-
 
−
| colspan="2" | Reads a 32-bit long value starting from the specified address. A 32-bit long will consume 4 bytes which will be 4 locations on an 8-bit device or 2 locations on a 16-bit device. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | StartAddress
 
−
|-
 
−
| colspan="2" | Initial EE location to start reading 
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | MSBFirst
 
−
|-
 
−
| colspan="2" | 0=LSB First, 1=MSB First 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
 +
{{Fcfile|Translations.fcfx|Translations Demo}}
  
−
{| 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;" | '''WriteString'''
 
−
|-
 
−
| colspan="2" | Writes a string of data to the EE memory starting at the specified address. 8-bit EE memory stores a character into each memory location. 16-bit EE memory stores two characters into each memory location. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | StartAddress
 
−
|-
 
−
| colspan="2" | EE Address of the first character in the string 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | MaxChars
 
−
|-
 
−
| colspan="2" | The maximum number of characters to try and read plus null termination 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | DataString
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
Clicking the buttons on the keypad selects the active language.
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
1=English
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Write'''
 
−
|-
 
−
| colspan="2" | Writes a packet of bits from the EEPROM The number of bits written is 8 or 16, depending on the platform  
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | The address, in elements, to write the data to 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Value
 
−
|-
 
−
| colspan="2" | The 8 or 16 bit value to store in EEPROM 
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
2=French
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
3=German
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByte'''
 
−
|-
 
−
| colspan="2" | Reads a 8-bit byte value starting from the specified address. A 8-bit byte will consume 1 byte which will be 1 locations on an 8-bit device or half a location on a 16-bit device. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | ByteAddress
 
−
|-
 
−
| colspan="2" | Byte address, EEADDR on 8-bit device or EEADDR/2 on a 16-bit device 
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | MSBFirst
 
−
|-
 
−
| colspan="2" | 0=LSB First, 1=MSB First 
 
−
|-
 
−
| 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;" | '''WriteLong'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTranslation'''
 
|-
 
|-
−
| colspan="2" | Writes a 32-bit long value starting at the specified address. A 32-bit long will consume 4 bytes which will be 4 locations on an 8-bit device or 2 locations on a 16-bit device. 
+
| colspan="2" | Gets the current translated version of the string 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | StartAddress
+
| width="90%" | Language
 
|-
 
|-
−
| colspan="2" | Initial EE location to start reading 
+
| colspan="2" | Range 0 - 7, 0=Default language 
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | Value
 
−
|-
 
−
| colspan="2" | Floating point value to write 
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | MSBFirst
 
−
|-
 
−
| colspan="2" | 0=LSB First, 1=MSB First 
 
−
|-
 
−
| 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" | Configures each matching sensor on the bus with the specified conversion bits. 
 
−
|-
 
−
|-
 
−
| 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 361: Line 109:
 
|-
 
|-
 
| colspan="2" | String used when language parameter set to 2 
 
| colspan="2" | String used when language parameter set to 2 
−
|-
 
−
| 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:24, 9 November 2022

Author Matrix TSL
Version 1.0
Category Storage


String Translator component

A simple component to allow multiple language support by substituting different strings depending on the selected language.

Component Pack

STORAGE

Detailed description

No detailed description exists yet for this component

Examples

Simple example showing how to use the translation component when designing multi-language user interfaces.

FC6 Icon.png Translations Demo


Clicking the buttons on the keypad selects the active language.

1=English

2=French

3=German

Downloadable macro reference

Fc9-comp-macro.png GetTranslation
Gets the current translated version of the string 
Fc9-u8-icon.png - BYTE Language
Range 0 - 7, 0=Default language 
Fc9-string-icon.png - STRING Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Language Count
Selects how many languages are present and controllable via the component. Range 1 - 8. 
Fc9-type-10-icon.png String0 (default)
String used when language parameter set to 0 
Fc9-type-10-icon.png String1
String used when language parameter set to 1 
Fc9-type-10-icon.png String2
String used when language parameter set to 2 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_String_Translator_(Storage)&oldid=28892"