Difference between revisions of "Component: USB Speaker (Misc)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_USBSpeaker.fcfx FC_Comp_Source_USBSpeaker.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_USBSpeaker.fcfx FC_Comp_Source_USBSpeaker.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_USBSpeaker.fcfx FC_Comp_Source_USBSpeaker.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 34: | Line 36: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 46: | Line 50: | ||
==Macro reference== | ==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;" | '''IsPlaybackEnabled''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''UsbRx''' | ||
| + | |- | ||
| + | | colspan="2" | Receives the data from the USB connection | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''ReadData''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a single 16-bit data value from the audio buffer | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''Initialise''' | ||
| + | |- | ||
| + | | colspan="2" | Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout. | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | USB Properties | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Vendor ID | ||
| + | |- | ||
| + | | colspan="2" | USB VID | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Product ID | ||
| + | |- | ||
| + | | colspan="2" | USB PID | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Device Name | ||
| + | |- | ||
| + | | colspan="2" | USB Device Name | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Manufacturer | ||
| + | |- | ||
| + | | colspan="2" | USB Manufacturer | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Major Version | ||
| + | |- | ||
| + | | colspan="2" | USB Major Version Number | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Minor Version | ||
| + | |- | ||
| + | | colspan="2" | USB Minor Version Number | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Sample Rate | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Enumeration Timeout | ||
| + | |- | ||
| + | | colspan="2" | Specifies if the enumeration (Initialise function) can timeout if taking too long. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Label | ||
| + | |- | ||
| + | | colspan="2" | Text displayed on the I/O flasher comms component. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 10:00, 27 January 2023
| Author | Matrix Ltd. |
| Version | 1.3 |
| Category | Misc |
Contents
USB Speaker component
Component to create a USB System Speaker. Compatible with USB enabled microcontroller devices. Currently only compatible with the 16-bit PIC range of devices.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_USBSpeaker.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_USBSpeaker.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
IsPlaybackEnabled |
 - BYTE
|
Return |
|
|
UsbRx |
| Receives the data from the USB connection | |
| - BYTE
|
Return |
|
|
ReadData |
| Reads a single 16-bit data value from the audio buffer | |
 - UINT
|
Return |
|
|
Initialise |
| Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout. | |
| - BYTE
|
Return |
Property reference
|
Properties |
|
USB Properties |
|
Vendor ID |
| USB VID | |
|
|
Product ID |
| USB PID | |
|
Device Name |
| USB Device Name | |
|
|
Manufacturer |
| USB Manufacturer | |
|
|
Major Version |
| USB Major Version Number | |
|
|
Minor Version |
| USB Minor Version Number | |
|
Sample Rate |
|
Enumeration Timeout |
| Specifies if the enumeration (Initialise function) can timeout if taking too long. | |
|
|
Simulation |
|
|
Label |
| Text displayed on the I/O flasher comms component. | |
==Macro reference==
|
|
IsPlaybackEnabled |
| - BYTE
|
Return |
|
|
UsbRx |
| Receives the data from the USB connection | |
| - BYTE
|
Return |
|
|
ReadData |
| Reads a single 16-bit data value from the audio buffer | |
| - UINT
|
Return |
|
|
Initialise |
| Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout. | |
| - BYTE
|
Return |
Property reference
|
|
Properties |
|
|
USB Properties |
|
|
Vendor ID |
| USB VID | |
|
|
Product ID |
| USB PID | |
|
|
Device Name |
| USB Device Name | |
|
|
Manufacturer |
| USB Manufacturer | |
|
|
Major Version |
| USB Major Version Number | |
|
|
Minor Version |
| USB Minor Version Number | |
|
|
Sample Rate |
|
|
Enumeration Timeout |
| Specifies if the enumeration (Initialise function) can timeout if taking too long. | |
|
|
Simulation |
|
|
Label |
| Text displayed on the I/O flasher comms component. | |
==Macro reference==
|
|
IsPlaybackEnabled |
| - BYTE
|
Return |
|
|
UsbRx |
| Receives the data from the USB connection | |
| - BYTE
|
Return |
|
|
ReadData |
| Reads a single 16-bit data value from the audio buffer | |
| - UINT
|
Return |
|
|
Initialise |
| Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout. | |
| - BYTE
|
Return |
Property reference
|
|
Properties |
|
|
USB Properties |
|
|
Vendor ID |
| USB VID | |
|
|
Product ID |
| USB PID | |
|
|
Device Name |
| USB Device Name | |
|
|
Manufacturer |
| USB Manufacturer | |
|
|
Major Version |
| USB Major Version Number | |
|
|
Minor Version |
| USB Minor Version Number | |
|
|
Sample Rate |
|
|
Enumeration Timeout |
| Specifies if the enumeration (Initialise function) can timeout if taking too long. | |
|
|
Simulation |
|
|
Label |
| Text displayed on the I/O flasher comms component. | |
==Macro reference==
|
|
IsPlaybackEnabled |
| - BYTE
|
Return |
|
|
UsbRx |
| Receives the data from the USB connection | |
| - BYTE
|
Return |
|
|
ReadData |
| Reads a single 16-bit data value from the audio buffer | |
| - UINT
|
Return |
|
|
Initialise |
| Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout. | |
| - BYTE
|
Return |
Property reference
|
|
Properties |
|
|
USB Properties |
|
|
Vendor ID |
| USB VID | |
|
|
Product ID |
| USB PID | |
|
|
Device Name |
| USB Device Name | |
|
|
Manufacturer |
| USB Manufacturer | |
|
|
Major Version |
| USB Major Version Number | |
|
|
Minor Version |
| USB Minor Version Number | |
|
|
Sample Rate |
|
|
Enumeration Timeout |
| Specifies if the enumeration (Initialise function) can timeout if taking too long. | |
|
|
Simulation |
|
|
Label |
| Text displayed on the I/O flasher comms component. | |
