Difference between revisions of "Component: Speech (Phoneme) (Audio Output)"

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gray...")
 
Line 16: Line 16:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
 
''No detailed description exists yet for this component''
 
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 125: Line 129:
 
|-
 
|-
 
| 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
 +
| 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;" | '''GetConsoleHandle'''
 +
|-
 +
| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc. 
 +
|-
 +
|-
 +
| 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;" | '''SendByteArray'''
 +
|-
 +
| colspan="2" | Sends an array of bytes to the COM port. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data byte array to send 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Length
 +
|-
 +
| colspan="2" | Number of bytes to send 
 +
|-
 +
| 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;" | '''ReceiveBinary16Bit'''
 +
|-
 +
| colspan="2" | Receives a binary 16-bit value split across two bytes. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBfirst
 +
|-
 +
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | Max amount of time in ms to wait between bytes 
 +
|-
 +
| 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;" | '''ReceiveFloat'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | Max time in ms to wait in between bytes 
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | IgnoreData
 +
|-
 +
| colspan="2" | 0=Dont ignore any data, 1=Ignore any initial none numeric data 
 +
|-
 +
| 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;" | '''SendFloat'''
 +
|-
 +
| colspan="2" | Sends out a floating point number as an ASCII String from the UART interface. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Number
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''SendHexNumber'''
 +
|-
 +
| colspan="2" | Sends out a number as an ASCII hexadecimal String from the UART interface. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Number
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | NumChars
 +
|-
 +
| colspan="2" | Number of characters in the string data, 0 for auto, 2 for 0x00, 4 for 0x0000 
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Prefix
 +
|-
 +
| colspan="2" | Generate hexadecimal prefix 0x e.g. 1= 0xFF, 0= FF 
 +
|-
 +
| 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;" | '''SetFlowControl'''
 +
|-
 +
| colspan="2" | Allows the Flowcontrol signals to be enabled or disabled. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | A value of 0 disables flow control, 1 or above willl enable flow control. 
 +
|-
 +
| 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;" | '''OpenPort'''
 +
|-
 +
| colspan="2" | Opens the currently selected COM port, allowing data to be sent and received. 
 +
|-
 +
|-
 +
| 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;" | '''ReceiveHexNumber'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | Max time in ms to wait in between bytes 
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | IgnoreData
 +
|-
 +
| colspan="2" | 0=Dont ignore any data, 1=Ignore any initial none numeric data 
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Prefix
 +
|-
 +
| colspan="2" | Look for prefix before receiving, 1=0xFF, 0=FF 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''SetProp'''
 +
|-
 +
| colspan="2" | Allows the COM port property to be set from a parent component. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | PropName
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | PropVal
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''SendBinary32Bit'''
 +
|-
 +
| colspan="2" | Sends out a 32-bit binary value split across four bytes. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBfirst
 +
|-
 +
| colspan="2" | 0=Least significant byte first, 1=Most significant byte 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;" | '''SendBinaryFloat'''
 +
|-
 +
| colspan="2" | Sends out a 32-bit binary floating point value split across four bytes. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBfirst
 +
|-
 +
| colspan="2" | 0=Least significant byte first, 1=Most significant byte 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;" | '''GetProp'''
 +
|-
 +
| colspan="2" | Allows the property filter for the COM port list to be copied to a parent component. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | PropName
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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;" | '''ReceiveByteArray'''
 +
|-
 +
| colspan="2" | Attempts to receive an array of bytes using the COM port Returns the number of bytes received.  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | MaxLength
 +
|-
 +
| colspan="2" | Max number of bytes to try and read 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | Time to wait for incoming data in milliseconds 
 +
|-
 +
| 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;" | '''ReceiveString'''
 +
|-
 +
| colspan="2" | Attempts to receive an string using the COM port Returns the number of bytes received.  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | Time to wait for incoming data in milliseconds 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | MaxLength
 +
|-
 +
| colspan="2" | Max number of bytes to try and read 
 +
|-
 +
| 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;" | '''PWMEnable'''
 +
|-
 +
| colspan="2" | 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 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | EnableMask
 +
|-
 +
| colspan="2" | Range 0-63 or 0b00000 to 0b111111 
 +
|-
 +
| 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" |  
 +
|-
 +
|-
 +
| 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;" | '''GetProp'''
 +
|-
 +
| colspan="2" | Allows the property filter for the COM port list to be copied to a parent component. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | PropName
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}

Revision as of 10:39, 17 November 2021

Author Matrix Ltd
Version 1.2
Category Audio Output


Speech (Phoneme) component

Speech component allowing Phoneme based speech for use on an embedded platform. The simulation also has an advanced speech engine allowing realistic text to speech in multiple languages using the RealSpeak voice engine.

Detailed description

No detailed description exists yet for this component

Examples

Example of Phoneme Speech (download and simulation) FC6 Icon.png Speech The Phoneme based speech can be output on Microcontroller hardware using a number of methods.


PWM - Outputs using a single PWM pin, a simple external RC low pass filter can be used to remove the high frequency PWM to create an audio signal.

Parallel - Outputs using a 8-bit port, a simple 8-bit R2R DAC circuit can be used to combine the bits into an audio signal.

Other - A third option is to use the ReadByteFromPhoneme macro to pull out the phoneme values a byte at a time which can be used to pass on to an external DAC etc.


Another example of Phoneme Speech, taking a reading from an analogue channel and speaking the Voltage. (download and simulation) FC6 Icon.png Talking Volt Meter Example of Real Speak Speech (simulation only) FC6 Icon.png Speech2 Adding additional language packs to the Real Speak engine.

Real Speak Voice Downloads

Downloadable macro reference

Fc9-comp-macro.png ReadPhonemeLength
Function to return the number of bytes used in a single phoneme array. 
Fc9-string-icon.png - STRING Phoneme
Specifies a single Phoneme 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png EnableOutput
Sets up the output to allow the speech data to be streamed out. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DisableOutput
Disables the output to prevent any buzzing etc while not speaking. 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png OutputPhoneme
Streams a single Phoneme or string of comma seperated Phonemes. OutputPhoneme("OY") OutputPhoneme("OY,AY,OY") 
Fc9-string-icon.png - STRING DataString
 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png SendByteArray
Sends an array of bytes to the COM port. 
Fc9-u8-icon.png - BYTE Data
Data byte array to send 
Fc9-u16-icon.png - UINT Length
Number of bytes to send 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - 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


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


Fc9-comp-macro.png SendHexNumber
Sends out a number as an ASCII hexadecimal String from the UART interface. 
Fc9-u32-icon.png - ULONG Number
 
Fc9-u8-icon.png - 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 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png OpenPort
Opens the currently selected COM port, allowing data to be sent and received. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - 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 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png SetProp
Allows the COM port property to be set from a parent component. 
Fc9-string-icon.png - STRING PropName
 
Fc9-u32-icon.png - ULONG PropVal
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SendBinary32Bit
Sends out a 32-bit binary value split across four bytes. 
Fc9-u32-icon.png - ULONG Value
 
[[File:]] - MSBfirst
0=Least significant byte first, 1=Most significant byte first 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetProp
Allows the property filter for the COM port list to be copied to a parent component. 
Fc9-string-icon.png - STRING PropName
 
Fc9-string-icon.png - STRING Return


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


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


Fc9-comp-macro.png 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 
Fc9-u8-icon.png - BYTE EnableMask
Range 0-63 or 0b00000 to 0b111111 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetProp
Allows the property filter for the COM port list to be copied to a parent component. 
Fc9-string-icon.png - STRING PropName
 
Fc9-string-icon.png - STRING Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Phoneme Selection
Selects which phonemes are included in the embedded firmware 
Fc9-type-16-icon.png Phoneme Data Set
Specifies if the phonemes used are based on the inbuilt phoneme wav files set or a custom file set. To create your own phonemes, copy the wav files from the components directory, then overwrite the phonemes you wish to edit. Phonemes are re-parsed on simulation start and on compile to C. 
Fc9-type-14-icon.png Pitch (Hz)
The frequency at which the phoneme data is output in bytes/samples per second. 
Fc9-type-14-icon.png Phoneme Data Size
The number of bytes used by the current phoneme selection 
Fc9-type-14-icon.png ROM Size
The maximum number of bytes available in the ROM of the selected target device. The ROM has to contain the program as well as the Phoneme data. 
Fc9-type-14-icon.png Base ROM Address
The address in ROM to place the phoneme data. It is recomended to always use the suggested address as this will place the phonemes right at the end of ROM and away from the program. 
Fc9-type-14-icon.png Suggested Address
The ideal address to allow all the selected phonemes to fit into the end of the ROM memory Thereby allowing the maximum space for the user program. 
Fc9-type-16-icon.png Output Mode
Determines how the phoneme data is going to be output. 
Fc9-type-16-icon.png PWM Pin
PWM channel selection used to determine which PWM peripheral to stream the Phoneme data to. 
Fc9-type-5-icon.png PWM Pin
The actual port pin assigned to the selected PWM channel. 
Fc9-type-16-icon.png Word Dictionary
 
Fc9-type-12-icon.png Phonemes
 
Fc9-type-14-icon.png Word Count
 
Fc9-type-7-icon.png Add
 
Fc9-type-10-icon.png Word
 
Fc9-type-10-icon.png Phonemes
 
Fc9-type-7-icon.png Delete All
 
Fc9-type-7-icon.png Select All
Selects all Phonemes 
Fc9-type-7-icon.png Select None
Deselects all Phonemes 
Fc9-type-7-icon.png PA1 (10ms)
10ms Pause - Always included 
Fc9-type-7-icon.png PA2 (30ms)
30ms Pause - Always included 
Fc9-type-7-icon.png PA3 (50ms)
50ms Pause - Always included 
Fc9-type-7-icon.png PA4 (100ms)
100ms Pause - Always included 
Fc9-type-7-icon.png PA5 (200ms)
200ms Pause - Always included 
Fc9-type-7-icon.png AA - hOt
Phoneme selection 
Fc9-type-7-icon.png AE - hAt
Phoneme selection 
Fc9-type-7-icon.png AO - AUght
Phoneme selection 
Fc9-type-7-icon.png AR - alARm
Phoneme selection 
Fc9-type-7-icon.png AW - sOUnd
Phoneme selection 
Fc9-type-7-icon.png AX - Apple
Phoneme selection 
Fc9-type-7-icon.png AY - skY
Phoneme selection 
Fc9-type-7-icon.png BB1 - Brown
Phoneme selection 
Fc9-type-7-icon.png BB2 - Business
Phoneme selection 
Fc9-type-7-icon.png CH - CHurCH
Phoneme selection 
Fc9-type-7-icon.png DD1 - enD
Phoneme selection 
Fc9-type-7-icon.png DD2 - Down
Phoneme selection 
Fc9-type-7-icon.png DH1 - THey
Phoneme selection 
Fc9-type-7-icon.png DH2 - baTHe
Phoneme selection 
Fc9-type-7-icon.png EH - Extent
Phoneme selection 
Fc9-type-7-icon.png EL - angLE
Phoneme selection 
Fc9-type-7-icon.png ER1 - intERupt
Phoneme selection 
Fc9-type-7-icon.png ER2 - bIRd
Phoneme selection 
Fc9-type-7-icon.png EY - grEAt
Phoneme selection 
Fc9-type-7-icon.png FF - Food
Phoneme selection 
Fc9-type-7-icon.png GG1 - Get
Phoneme selection 
Fc9-type-7-icon.png GG2 - Green
Phoneme selection 
Fc9-type-7-icon.png GG3 - anGer
Phoneme selection 
Fc9-type-7-icon.png HH1 - Help
Phoneme selection 
Fc9-type-7-icon.png HH2 - Hope
Phoneme selection 
Fc9-type-7-icon.png IH - sIt
Phoneme selection 
Fc9-type-7-icon.png IY - trEAt
Phoneme selection 
Fc9-type-7-icon.png JH - inJure
Phoneme selection 
Fc9-type-7-icon.png KK1 - Clown
Phoneme selection 
Fc9-type-7-icon.png KK2 - tasK
Phoneme selection 
Fc9-type-7-icon.png KK3 - Crane
Phoneme selection 
Fc9-type-7-icon.png LL - Lake
Phoneme selection 
Fc9-type-7-icon.png MM - Milk
Phoneme selection 
Fc9-type-7-icon.png NG - aNGer
Phoneme selection 
Fc9-type-7-icon.png NN1 - thiN
Phoneme selection 
Fc9-type-7-icon.png NN2 - Now
Phoneme selection 
Fc9-type-7-icon.png OR - stORe
Phoneme selection 
Fc9-type-7-icon.png OW - zOne
Phoneme selection 
Fc9-type-7-icon.png OY - nOIse
Phoneme selection 
Fc9-type-7-icon.png PP - triP
Phoneme selection 
Fc9-type-7-icon.png RR1 - WRite
Phoneme selection 
Fc9-type-7-icon.png RR2 - gRease
Phoneme selection 
Fc9-type-7-icon.png SH - SHip
Phoneme selection 
Fc9-type-7-icon.png SS - teSt
Phoneme selection 
Fc9-type-7-icon.png TH - THin
Phoneme selection 
Fc9-type-7-icon.png TT1 - tesT
Phoneme selection 
Fc9-type-7-icon.png TT2 - Test
Phoneme selection 
Fc9-type-7-icon.png UH - bOOk
Phoneme selection 
Fc9-type-7-icon.png UW1 - cumpUter
Phoneme selection 
Fc9-type-7-icon.png UW2 - fOOd
Phoneme selection 
Fc9-type-7-icon.png VV - Vest
Phoneme selection 
Fc9-type-7-icon.png WH - WHite
Phoneme selection 
Fc9-type-7-icon.png WW - Work
Phoneme selection 
Fc9-type-7-icon.png XR - haiR
Phoneme selection 
Fc9-type-7-icon.png YR - clEAR
Phoneme selection 
Fc9-type-7-icon.png YY1 - compUter
Phoneme selection 
Fc9-type-7-icon.png YY2 - Yes
Phoneme selection 
Fc9-type-7-icon.png ZH - aZure
Phoneme selection 
Fc9-type-7-icon.png ZZ - phaSe
Phoneme selection 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations