Difference between revisions of "Component: USB HID (Comms: USB)"

From Flowcode Help
Jump to navigationJump to search
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.3 (Release)
+
| 1.4
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Comms: USB
 
| Comms: USB
 
|}
 
|}
  
  
 +
==USB HID component==
 +
Component to create and communicate using a standard HID type USB class. Compatible with simulation and USB enabled microcontroller devices PIC/dsPIC/AVR. Note that AVR is currently in Beta and may have problems with custom descriptors.
  
−
==[[File:Component Icon 06a0a9b3_dd23_4592_a781_537a31b97c2a.png|Image]] USB HID component==
+
==Component Source Code==
−
Component to create and communicate using a standard HID type USB class.
 
−
Compatible with simulation and USB enabled microcontroller devices PIC/dsPIC/AVR.
 
−
Note that AVR is currently in Beta and may have problems with custom descriptors.
 
  
−
==Examples==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_USBHID.fcfx FC_Comp_Source_USBHID.fcfx]
−
Here are some examples to get you started with USB HID communications using Flowcode.
 
  
−
===HID Mouse===
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_USBHID.fcfx FC_Comp_Source_USBHID.fcfx]
  
−
Reads a EB014 keypad and depending on the key pressed sends the appropriate movement and button clicks to control the mouse. The speed is set by the speed variable which can range from 1 to 127.
+
==Detailed description==
−
{{Fcfile|USB_HID_Mouse.fcfx|Mouse Keypad Example}}
 
−
Key breakdown: 1 = UpLeft, 2=Up, 3=UpRight, 4=Left, 6=Right, 7=DownLeft, 8=Down, 9=DownRight, *=Left Click, #=Right Click.
 
  
  
  
−
Reads two encoders and moves the mouse cursor based on their movement since the last operation. A switch on pin B0 can be used to toggle the left mouse click on and off and pin B1 can be connected to an LED to show the status of the left mouse button. The EB073 encoders board connected to PortB will allow all of this functionality.
 
−
{{Fcfile|USB_HID_Etch_A_Sketch.fcfx|Mouse Encoder Example}}
 
−
===HID Keyboard===
 
  
−
Converts a ASCII character into a keypress that will be sent to the USB host device. A demo string is provided which is then broken down into characters and sent to the USB host.
 
−
{{Fcfile|USB_HID_Keyboard.fcfx|Keyboard Example}}
 
−
Here is a file showing the standard HID keyboard scan codes to help make sense of the example.
 
  
−
[[File:HID Keyboard Scan Codes.xls]]
 
  
  
−
With the example running if you create a text file and highlight the text file then the USB device will populate the file with data.
 
  
  
−
E.g.
 
  
−
HelloFromYourUSBKeyboardDevice12345
 
  
−
HelloFromYourUSBKeyboardDevice12345
 
  
−
HelloFromYourUSBKeyboardDevice12345
 
  
  
−
Currently only compatible with the following characters: 0123456789!"£$%^&*()/\*-+ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\n\t
 
  
−
===HID Descriptor Tool===
 
  
−
This tool allows you to create your own descriptors which can then be inserted into the HID descriptor property with the custom descriptor type selected.
 
  
−
[[File:HID Descriptor Tool.zip]]
 
  
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>ReceiveByte</tt></u></span>===
 
−
Receives a byte from the USB.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Idx''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
−
===<span style="font-weight: normal;"><u><tt>SetSerialNumber</tt></u></span>===
 
−
Allows the device serial number to be edited.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|<- STRING]] ''SerialNumber''
 
−
::''This parameter may be returned back to the caller''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SendData</tt></u></span>===
 
−
Sends the contents of the transmit buffer to the USB.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>CheckRx</tt></u></span>===
 
−
Checks for any incoming data.
 
  
−
Returns the number of data bytes received since the last check.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>UpdateData</tt></u></span>===
 
−
Allows a byte of the transmit buffer to be assigned.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''idx''
 
  
−
:[[Variable Types|BYTE]] ''value''
+
Here are some examples to get you started with USB HID communications using Flowcode.
  
 +
===HID Mouse===
  
−
'''Return value'''
+
Reads a EB014 keypad and depending on the key pressed sends the appropriate movement and button clicks to control the mouse.
  
−
:''This call does not return a value''
+
The speed is set by the speed variable which can range from 1 to 127.
  
 +
{{Fcfile|USB_HID_Mouse.fcfx|Mouse Keypad Example}}
  
−
===<span style="font-weight: normal;"><u><tt>ReceiveString</tt></u></span>===
+
Key breakdown: 1 = UpLeft, 2=Up, 3=UpRight, 4=Left, 6=Right, 7=DownLeft, 8=Down, 9=DownRight, *=Left Click, #=Right Click.
−
Receives a string of bytes from the USB
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''NumBytes''
+
Reads two encoders and moves the mouse cursor based on their movement since the last operation.
  
 +
A switch on pin B0 can be used to toggle the left mouse click on and off and pin B1 can be connected to an LED to show the status of the left mouse button.
  
−
'''Return value'''
+
The EB073 encoders board connected to PortB will allow all of this functionality.
  
−
:[[Variable Types|STRING]]
 
  
 +
{{Fcfile|USB_HID_Etch_A_Sketch.fcfx|Mouse Encoder Example}}
  
−
===<span style="font-weight: normal;"><u><tt>SendDataDirect</tt></u></span>===
 
−
Sends data directly to the USB
 
  
−
'''Parameters'''
+
===HID Keyboard===
  
−
:[[Variable Types|<- STRING]] ''Data''
+
Converts a ASCII character into a keypress that will be sent to the USB host device.
−
::''This parameter may be returned back to the caller''
 
  
 +
A demo string is provided which is then broken down into characters and sent to the USB host.
  
−
'''Return value'''
+
{{Fcfile|USB_HID_Keyboard.fcfx|Keyboard Example}}
  
−
:[[Variable Types|BYTE]]
 
  
 +
Here is a file showing the standard HID keyboard scan codes to help make sense of the example.
  
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
+
[[File:HID Keyboard Scan Codes.xls]]
−
Starts up the USB connection and waits for the device driver to be correctly installed on the PC.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
With the example running if you create a text file and highlight the text file then the USB device will populate the file with data.
  
  
−
'''Return value'''
+
E.g.
  
−
:[[Variable Types|BYTE]]
+
HelloFromYourUSBKeyboardDevice12345
  
 +
HelloFromYourUSBKeyboardDevice12345
  
 +
HelloFromYourUSBKeyboardDevice12345
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
+
Currently only compatible with the following characters: 0123456789!"£$%^&*()/\*-+ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\n\t
  
  
−
==Property reference==
+
A complete list of keyboard scan codes can be found here under section 7 - Keyboards.
−
<span style="font-weight: normal;"><u>Vendor ID</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''vendor_ID''.
+
http://www.freebsddiary.org/APC/usb_hid_usages.php
  
−
USB vendor identifier tied to the manufacturer of the USB device
 
  
−
<span style="font-weight: normal;"><u>Product ID</u></span>
+
===HID Descriptor Tool===
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''product_ID''.
+
This tool allows you to create your own descriptors which can then be inserted into the HID descriptor property with the custom descriptor type selected.
  
−
USB product identifier
+
[[File:HID Descriptor Tool.zip]]
  
−
<span style="font-weight: normal;"><u>Device Name</u></span>
 
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''dev_name''.
 
  
−
Name used to identify the device
 
  
−
<span style="font-weight: normal;"><u>Manufacturer</u></span>
 
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''dev_manufacturer''.
 
  
−
Manufacturer of the device
 
  
−
<span style="font-weight: normal;"><u>Major Version</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''major_version''.
 
  
−
Firmware major version
 
  
−
<span style="font-weight: normal;"><u>Minor Version</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''minor_version''.
+
==Macro reference==
  
−
Device firmware minor version
+
===CheckRx===
 +
{| 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;" | '''CheckRx'''
 +
|-
 +
| colspan="2" | Checks for any incoming data. Returns the number of data bytes received since the last check.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Enumeration Timeout</u></span>
 
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''enumeration_tout''.
+
===Initialise===
 +
{| 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 connection and waits for the device driver to be correctly installed on the PC. &nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
Specifies if the initialise routine is allowed to timeout instead of waiting forever for success
 
  
−
<span style="font-weight: normal;"><u>Maximum Current (mA)</u></span>
+
===ReceiveByte===
 +
{| 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;" | '''ReceiveByte'''
 +
|-
 +
| colspan="2" | Receives a byte from the USB.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Idx
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''max_current''.
 
  
−
Maximum current the host should source to the device - max 500mA
+
===ReceiveString===
 +
{| 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" | Receives a string of bytes from the USB&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | NumBytes
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Country Code</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cntry_code''.
+
===SendData===
 +
{| 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;" | '''SendData'''
 +
|-
 +
| colspan="2" | Sends the contents of the transmit buffer to the USB.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
Specific country code - if required
 
  
−
<span style="font-weight: normal;"><u>Descriptor Select</u></span>
+
===SendDataDirect===
 +
{| 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;" | '''SendDataDirect'''
 +
|-
 +
| colspan="2" | Sends data directly to the USB&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''descriptor_Select''.
 
  
−
Built in descriptor selection
+
===SetSerialNumber===
 +
{| 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;" | '''SetSerialNumber'''
 +
|-
 +
| colspan="2" | Allows the device serial number to be edited.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | SerialNumber
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>HID Descriptor</u></span>
 
  
−
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''HID_descriptor''.
+
===UpdateData===
 +
{| 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;" | '''UpdateData'''
 +
|-
 +
| colspan="2" | Allows a byte of the transmit buffer to be assigned.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | idx
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
Contents of the HID descriptor
 
  
−
<span style="font-weight: normal;"><u>Subclass</u></span>
+
==Property reference==
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''subclass''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
USB Subclass - Normally only mice and keyboards are boot devices
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Interface</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''interface''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | USB Properties
−
Standard HID interface type
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Transmit Packet Size</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Vendor ID
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''tx_packet_size''.
+
|-
−
 
+
| colspan="2" | USB vendor identifier tied to the manufacturer of the USB device&nbsp;
−
Number of bytes to send to the PC
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
<span style="font-weight: normal;"><u>Transmit Period (ms)</u></span>
+
| width="90%" | Product ID
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''tx_period''.
+
| colspan="2" | USB product identifier&nbsp;
−
 
+
|-
−
Delay between transmit packets
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Device Name
−
<span style="font-weight: normal;"><u>Receive Packet Size</u></span>
+
|-
−
 
+
| colspan="2" | Name used to identify the device&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''rx_packet_size''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
Number of bytes to receive from the PC
+
| width="90%" | Manufacturer
−
 
+
|-
−
<span style="font-weight: normal;"><u>Receive Period (ms)</u></span>
+
| colspan="2" | Manufacturer of the device&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''rx_period''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Major Version
−
Delay between receive packets
+
|-
−
 
+
| colspan="2" | Firmware major version&nbsp;
−
<span style="font-weight: normal;"><u>Label</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
+
| width="90%" | Minor Version
−
 
+
|-
−
Simulation label used to indicate the USB HID component on the panel.
+
| colspan="2" | Device firmware minor version &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Enumeration Timeout
 +
|-
 +
| colspan="2" | Specifies if the initialise routine is allowed to timeout instead of waiting forever for success&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Maximum Current (mA)
 +
|-
 +
| colspan="2" | Maximum current the host should source to the device - max 500mA&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Country Code
 +
|-
 +
| colspan="2" | Specific country code - if required&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Descriptor Select
 +
|-
 +
| colspan="2" | Built in descriptor selection &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 +
| width="90%" | HID Descriptor
 +
|-
 +
| colspan="2" | Contents of the HID descriptor&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Subclass
 +
|-
 +
| colspan="2" | USB Subclass - Normally only mice and keyboards are boot devices&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Interface
 +
|-
 +
| colspan="2" | Standard HID interface type&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Transmit Packet Size
 +
|-
 +
| colspan="2" | Number of bytes to send to the PC &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Transmit Period (ms)
 +
|-
 +
| colspan="2" | Delay between transmit packets&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Receive Packet Size
 +
|-
 +
| colspan="2" | Number of bytes to receive from the PC&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Receive Period (ms)
 +
|-
 +
| colspan="2" | Delay between receive packets&nbsp;
 +
|-
 +
| 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" | Simulation label used to indicate the USB HID component on the panel.&nbsp;
 +
|}

Latest revision as of 13:13, 7 February 2023

Author Matrix Ltd
Version 1.4
Category Comms: USB


USB HID component

Component to create and communicate using a standard HID type USB class. Compatible with simulation and USB enabled microcontroller devices PIC/dsPIC/AVR. Note that AVR is currently in Beta and may have problems with custom descriptors.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_USBHID.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_USBHID.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Here are some examples to get you started with USB HID communications using Flowcode.

HID Mouse

Reads a EB014 keypad and depending on the key pressed sends the appropriate movement and button clicks to control the mouse.

The speed is set by the speed variable which can range from 1 to 127.

FC6 Icon.png Mouse Keypad Example

Key breakdown: 1 = UpLeft, 2=Up, 3=UpRight, 4=Left, 6=Right, 7=DownLeft, 8=Down, 9=DownRight, *=Left Click, #=Right Click.


Reads two encoders and moves the mouse cursor based on their movement since the last operation.

A switch on pin B0 can be used to toggle the left mouse click on and off and pin B1 can be connected to an LED to show the status of the left mouse button.

The EB073 encoders board connected to PortB will allow all of this functionality.


FC6 Icon.png Mouse Encoder Example


HID Keyboard

Converts a ASCII character into a keypress that will be sent to the USB host device.

A demo string is provided which is then broken down into characters and sent to the USB host.

FC6 Icon.png Keyboard Example


Here is a file showing the standard HID keyboard scan codes to help make sense of the example.

File:HID Keyboard Scan Codes.xls


With the example running if you create a text file and highlight the text file then the USB device will populate the file with data.


E.g.

HelloFromYourUSBKeyboardDevice12345

HelloFromYourUSBKeyboardDevice12345

HelloFromYourUSBKeyboardDevice12345


Currently only compatible with the following characters: 0123456789!"£$%^&*()/\*-+ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\n\t


A complete list of keyboard scan codes can be found here under section 7 - Keyboards.

http://www.freebsddiary.org/APC/usb_hid_usages.php


HID Descriptor Tool

This tool allows you to create your own descriptors which can then be inserted into the HID descriptor property with the custom descriptor type selected.

File:HID Descriptor Tool.zip






Macro reference

CheckRx

Fc9-comp-macro.png CheckRx
Checks for any incoming data. Returns the number of data bytes received since the last check. 
Fc9-u8-icon.png - BYTE Return


Initialise

Fc9-comp-macro.png Initialise
Starts up the USB connection and waits for the device driver to be correctly installed on the PC.  
Fc9-u8-icon.png - BYTE Return


ReceiveByte

Fc9-comp-macro.png ReceiveByte
Receives a byte from the USB. 
Fc9-u8-icon.png - BYTE Idx
 
Fc9-u8-icon.png - BYTE Return


ReceiveString

Fc9-comp-macro.png ReceiveString
Receives a string of bytes from the USB 
Fc9-u8-icon.png - BYTE NumBytes
 
Fc9-string-icon.png - STRING Return


SendData

Fc9-comp-macro.png SendData
Sends the contents of the transmit buffer to the USB. 
Fc9-u8-icon.png - BYTE Return


SendDataDirect

Fc9-comp-macro.png SendDataDirect
Sends data directly to the USB 
Fc9-string-icon.png - STRING Data
 
Fc9-u8-icon.png - BYTE Return


SetSerialNumber

Fc9-comp-macro.png SetSerialNumber
Allows the device serial number to be edited. 
Fc9-string-icon.png - STRING SerialNumber
 
Fc9-void-icon.png - VOID Return


UpdateData

Fc9-comp-macro.png UpdateData
Allows a byte of the transmit buffer to be assigned. 
Fc9-u8-icon.png - BYTE idx
 
Fc9-u8-icon.png - BYTE value
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png USB Properties
Fc9-type-21-icon.png Vendor ID
USB vendor identifier tied to the manufacturer of the USB device 
Fc9-type-21-icon.png Product ID
USB product identifier 
Fc9-type-10-icon.png Device Name
Name used to identify the device 
Fc9-type-10-icon.png Manufacturer
Manufacturer of the device 
Fc9-type-14-icon.png Major Version
Firmware major version 
Fc9-type-14-icon.png Minor Version
Device firmware minor version  
Fc9-type-7-icon.png Enumeration Timeout
Specifies if the initialise routine is allowed to timeout instead of waiting forever for success 
Fc9-type-14-icon.png Maximum Current (mA)
Maximum current the host should source to the device - max 500mA 
Fc9-type-16-icon.png Country Code
Specific country code - if required 
Fc9-type-16-icon.png Descriptor Select
Built in descriptor selection  
Fc9-type-11-icon.png HID Descriptor
Contents of the HID descriptor 
Fc9-type-16-icon.png Subclass
USB Subclass - Normally only mice and keyboards are boot devices 
Fc9-type-16-icon.png Interface
Standard HID interface type 
Fc9-type-14-icon.png Transmit Packet Size
Number of bytes to send to the PC  
Fc9-type-14-icon.png Transmit Period (ms)
Delay between transmit packets 
Fc9-type-14-icon.png Receive Packet Size
Number of bytes to receive from the PC 
Fc9-type-14-icon.png Receive Period (ms)
Delay between receive packets 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
Simulation label used to indicate the USB HID component on the panel. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_USB_HID_(Comms:_USB)&oldid=38399"