Component: String Translator (Storage)

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.

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.

Translations Demo

Clicking the buttons on the keypad selects the active language.

1=English

2=French

3=German

Downloadable macro reference

	GetTranslation
Gets the current translated version of the string
- BYTE	Language
Range 0 - 7, 0=Default language
- STRING	Return

	ReadInt
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.
- UINT	StartAddress
Initial EE location to start reading
[[File:]] -	MSBFirst
0=LSB First, 1=MSB First
- UINT	Return

	ReadFloat
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.
- UINT	StartAddress
Initial EE location to start reading
[[File:]] -	MSBFirst
0=LSB First, 1=MSB First
[[File:]] -	Return

	WriteByte
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.
- UINT	ByteAddress
Byte address, EEADDR on 8-bit device or EEADDR/2 on a 16-bit device
- BYTE	Value
Floating point value to write
- VOID	Return

	WriteInt
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.
- UINT	StartAddress
Initial EE location to start reading
- UINT	Value
Floating point value to write
[[File:]] -	MSBFirst
0=LSB First, 1=MSB First
- VOID	Return

	ReadString
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.
- UINT	StartAddress
EE Address of the first character in the string
- BYTE	MaxChars
The maximum number of characters to try and read plus null termination
- STRING	Return

	Read
Reads a packet of bits from the EEPROM The number of bits read is 8 or 16, depending on the platform
- UINT	Address
The address, in elements, to read the data from
- UINT	Return

	ReadLong
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.
- UINT	StartAddress
Initial EE location to start reading
[[File:]] -	MSBFirst
0=LSB First, 1=MSB First
- ULONG	Return

	WriteString
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.
- UINT	StartAddress
EE Address of the first character in the string
- BYTE	MaxChars
The maximum number of characters to try and read plus null termination
- STRING	DataString
- VOID	Return

	Write
Writes a packet of bits from the EEPROM The number of bits written is 8 or 16, depending on the platform
- UINT	Address
The address, in elements, to write the data to
- UINT	Value
The 8 or 16 bit value to store in EEPROM
- VOID	Return

	ReadByte
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.
- UINT	ByteAddress
Byte address, EEADDR on 8-bit device or EEADDR/2 on a 16-bit device
[[File:]] -	MSBFirst
0=LSB First, 1=MSB First
- BYTE	Return

	WriteLong
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.
- UINT	StartAddress
Initial EE location to start reading
- ULONG	Value
Floating point value to write
[[File:]] -	MSBFirst
0=LSB First, 1=MSB First
- VOID	Return

	Initialise
Configures each matching sensor on the bus with the specified conversion bits.
- VOID	Return

	SendBinaryFloat
Sends out a 32-bit binary floating point value split across four bytes.
[[File:]] -	Value
[[File:]] -	MSBfirst
0=Least significant byte first, 1=Most significant byte first
- VOID	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

	ReceiveByteArray
Attempts to receive an array of bytes using the COM port Returns the number of bytes received.
- BYTE	Data
- UINT	MaxLength
Max number of bytes to try and read
- UINT	Timeout
Time to wait for incoming data in milliseconds
- UINT	Return

	ReceiveString
Attempts to receive an string using the COM port Returns the number of bytes received.
- UINT	Timeout
Time to wait for incoming data in milliseconds
- UINT	MaxLength
Max number of bytes to try and read
- STRING	Return

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

	Initialise
- VOID	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

Property reference

	Properties
	Language Count
Selects how many languages are present and controllable via the component. Range 1 - 8.
	String0 (default)
String used when language parameter set to 0
	String1
String used when language parameter set to 1
	String2
String used when language parameter set to 2
	Connections
	Simulations