Component: Base 64 (Storage)

Author	Matrix TSL
Version	1.0
Category	Storage

Base 64 component

Component to allow base 64 encoding and decoding. Sometimes when communicating raw binary data it is useful to perform base 64 encoding to ensure that none of your data bytes trigger any escape codes or other special case conditions. Base64 converts your binary data into readable data using standard ASCII characters so you can be fairly certain that the data you send is the same as the data that is received.

Detailed description

No detailed description exists yet for this component

Examples

Here is a basic example that shows how to convert data into base64 encoded data and visa versa. Base64 Tests

Downloadable macro reference

	Encode
Encodes an array of bytes into a base64 encoded string
- BYTE	BinaryData
Raw binary data array you wish to encode
- UINT	ByteCount
Number of bytes of data to encode
- STRING	Return

	Decode
Decodes a base64 encoded string into an array of bytes. Populates the BinaryData parameter array with the decoded data. Returns the number of decoded data bytes.
- BYTE	BinaryData
Variable to hold the decoded binary data
- STRING	Base64Data
Data string you wish to decode
- UINT	Return

	DisableOutput
Disables the output to prevent any buzzing etc while not speaking.
- VOID	Return

	ReadByteFromPhoneme
Reads a single byte value from the specified phoneme data array. This function will not simulate correctly as it requires C style pointers.
- STRING	Phoneme
Specifies a single Phoneme
- UINT	Idx
Specifies the position within the Phoneme
- BYTE	Return

	OutputPhoneme
Streams a single Phoneme or string of comma seperated Phonemes. OutputPhoneme("OY") OutputPhoneme("OY,AY,OY")
- STRING	DataString
- VOID	Return

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
[[File:]] -	Return

	SendByteArray
Sends an array of bytes to the COM port.
- BYTE	Data
Data byte array to send
- UINT	Length
Number of bytes to send
- VOID	Return

	ReceiveBinary16Bit
Receives a binary 16-bit value split across two bytes.
[[File:]] -	MSBfirst
0=Least significant byte first, 1=Most significant byte first
- BYTE	Timeout
Max amount of time in ms to wait between bytes
- UINT	Return

	ReceiveFloat
Attempts to receive a floating point number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost.
- BYTE	Timeout
Max time in ms to wait in between bytes
[[File:]] -	IgnoreData
0=Dont ignore any data, 1=Ignore any initial none numeric data
[[File:]] -	Return

	SendFloat
Sends out a floating point number as an ASCII String from the UART interface.
[[File:]] -	Number
- VOID	Return

	SendHexNumber
Sends out a number as an ASCII hexadecimal String from the UART interface.
- ULONG	Number
- BYTE	NumChars
Number of characters in the string data, 0 for auto, 2 for 0x00, 4 for 0x0000
[[File:]] -	Prefix
Generate hexadecimal prefix 0x e.g. 1= 0xFF, 0= FF
- VOID	Return

	SetFlowControl
Allows the Flowcontrol signals to be enabled or disabled.
- BYTE	State
A value of 0 disables flow control, 1 or above willl enable flow control.
- VOID	Return

	OpenPort
Opens the currently selected COM port, allowing data to be sent and received.
- VOID	Return

	ReceiveHexNumber
Attempts to receive a hex number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none hexadecimal char is received, the none numeric char will be lost.
- BYTE	Timeout
Max time in ms to wait in between bytes
[[File:]] -	IgnoreData
0=Dont ignore any data, 1=Ignore any initial none numeric data
[[File:]] -	Prefix
Look for prefix before receiving, 1=0xFF, 0=FF
- ULONG	Return

	SetProp
Allows the COM port property to be set from a parent component.
- STRING	PropName
- ULONG	PropVal
- VOID	Return

	SendBinary32Bit
Sends out a 32-bit binary value split across four bytes.
- ULONG	Value
[[File:]] -	MSBfirst
0=Least significant byte first, 1=Most significant byte first
- 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
	Connections
	Simulations