/*!
    \file  readme.txt
    \brief description of the USB Custom HID device demo
*/

/*
    Copyright (C) 2017 GigaDevice

    2014-12-26, V1.0.0, platform GD32F1x0(x=5)
    2016-01-15, V2.0.0, platform GD32F1x0(x=5)
    2016-04-30, V3.0.0, firmware update for GD32F1x0(x=5)
    2017-06-19, V3.1.0, firmware update for GD32F1x0(x=5)
*/

  This demo is based on the GD32150R-EVAL board,it provides a description of 
how to use the USB-Device peripheral.

  The GD32 device is enumerated as an USB Custom HID device, that uses the 
native PC Host HID driver.

  To test the demo, you need to:
    - Download the "Custom_HID Client" PC applet
    - Start the "Custom_HID Client" PC applet and connect GD32 USB to PC
    - The device should be detected and shown in the PC applet 
    - Make sure that following report ID are configured: LED1 ID (0x11),
      LED2 ID(0x12), LED3 ID(0x13), LED4 ID(0x14), BUTTON1_ID(0x15) and
      BUTTON2_ID(0x16).
    - Select Leds in the applet to switch on/off on the EVAL board 
    - Press the Wakeup key and Tamper key on the EVAL board to switch on
      /off the button1/button2 status in the PC applet