Component: USB Slave (Comms: USB)

Author	Matrix Ltd.
Version	1.3
Category	Comms: USB

USB Slave component

Component to create and communicate using a generic USB communications profile. Has the ability to allow the device to be a slave to the PC. Compatible with simulation and USB enabled microcontroller devices (PIC/dsPIC).

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/USBSlave.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/USBSlave.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

CheckRx

	CheckRx
Called to check if there is any incoming data waiting to be received. Returns the number of incoming data bytes. Only needed when not running the slave service.
- BYTE	Return

GetByte

	GetByte
Retreives the byte at location Idx from the incoming data buffer.
- BYTE	Idx
Specifies the location in the incoming buffer
- BYTE	Return

GetString

	GetString
Retreives a string of data from the incoming data buffer starting from location 0 and incrementing up to the NumBytes parameter.
- BYTE	NumBytes
Specifies the maximum number of bytes to try and read.
- STRING	Return

Initialise

	Initialise
Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout.
- BYTE	Return

RunSlaveService

	RunSlaveService
Stalls the microcontroller and waits for an incoming message from the USB, when a message is received the macro defined in the USB Slave properties is automatically run. While the macro is running you can choose to send data back to the PC if you wish.
- VOID	Return

SendByte

	SendByte
Adds the byte onto the end of the outgoing data buffer.
- BYTE	Data
Data byte to transmit to the host
- BYTE	Return

SendByteArray

	SendByteArray
Adds an array of bytes onto the end of the outgoing data buffer.
[[File:]] -	Data
Data Bytes To Send
- BYTE	Length
Max number of bytes to try and add to the outgoing buffer.
- BYTE	Return

SendString

	SendString
Adds a string of bytes onto the end of the outgoing data buffer.
- STRING	Data
Data String To Send
- BYTE	Length
Max number of bytes to try and add to the outgoing buffer.
- BYTE	Return

StopSlaveService

	StopSlaveService
Allows the microcontroller to leave the stalled slave mode and resume its normal independant functionality. Must be called from within the slave service routine to work correctly.
- VOID	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
	Enumeration Timeout
Specifies if the enumeration (Initialise function) can timeout if taking too long.
	Country Code
Country code used by some regional based USB devices
	Maximum Current (mA)
Maximum amount of current the USB host will provide before shutting down the USB channel.
	Slave Macro Properties
	Slave Macro
Flowcode macro to call while the slave service is enabled
	Macro Parameters
Defines the parameters for the slave service macro allowing data from the host to be automatically passed into the macro.
	USB Driver
	Driver Directory
Directory to save the generated device driver .inf file
	Driver Filename
Filename assigned to the USB device driver .inf file when generated.
	Generate Driver
Generates a driver file when set to Yes, Automatically jumps back to No when complete.
	Simulation
	Instance
Hardware instance to communicate with any connected USB slave devices.
	Timeout (ms)
Simulation host to slave communications timeout in milliseconds
	Label
Text displayed on the I/O flasher comms component.