Changing USB device VID PID

sstaub · April 19, 2018, 12:33pm

It is possible to change the USB VID and PID within the platformio.ini
instead of changing the IDs in the board .json file?

sstaub · June 17, 2019, 11:03am

Any ideas? I think I have seen another post.

ivankravets · July 10, 2019, 10:50am

There is Redirecting...
However, it does not work for arrays.

So, extra scripting will help here Redirecting...

sstaub · July 10, 2019, 2:11pm

Thank you, good to know.

gbrricci · December 2, 2019, 5:49am

Found this thread through google and helped me out in getting my multiple arduinos set up for a flight sim. Here’s a summary of what I did from the link provided above:

in platformIO locate ‘platform.ini’ in base project folder
add “extra_scripts = pre:custon_hwids.py” into ‘platform.ini’.
add a file into the main project folder and label it ‘custom_hwids.py’ or anything as long as it matches what was added to ‘platform.ini’
the link provided input on changing VIDS and PIDS through a HWID array (first block is VIDS, second block is PIDS)
you can also use board_config.update(“build.usb_product”, “Right Leo”) to relabel the board that windows sees.

Import(“env”)

board_config = env.BoardConfig()

board_config.update(“build.hwids”, [
[“0x2341”, “0x2341”, “0x2A03”, “0x2A03”], #VIDS
[“0x0036”, “0x8036”, “0x0036”, “0x8036”] #PIDS
])

board_config.update(“build.usb_product”, “Right Leo”)

sstaub · January 19, 2020, 5:03pm

Tried it with an Arduino Nano Every with no luck.

sstaub · January 20, 2020, 3:09pm

Here a screenshot of my config, nothing happens.

maxgerhardt · January 20, 2020, 6:23pm

Well given the automatic upload logic

github.com

platformio/platformio-core/blob/d1b46c838ee984dd242a819d2c4c4ee5c2b10250/platformio/builder/tools/pioupload.py#L126-L145


      
          def _look_for_serial_port():
              port = None
              board_hwids = []
              upload_protocol = env.subst("$UPLOAD_PROTOCOL")
              if "BOARD" in env and "build.hwids" in env.BoardConfig():
                  board_hwids = env.BoardConfig().get("build.hwids")
              for item in util.get_serial_ports(filter_hwid=True):
                  if not _is_match_pattern(item["port"]):
                      continue
                  port = item["port"]
                  if upload_protocol.startswith("blackmagic"):
                      if WINDOWS and port.startswith("COM") and len(port) > 4:
                          port = "\\\\.\\%s" % port
                      if "GDB" in item["description"]:
                          return port
                  for hwid in board_hwids:
                      hwid_str = ("%s:%s" % (hwid[0], hwid[1])).replace("0x", "")
                      if hwid_str in item["hwid"]:
                          return port
              return port

This should work. Can you fully describe your setup with the attached devices and corresponding PIDs, VIDs and product IDs? Also a log of pio run -t upload -v?

sstaub · January 21, 2020, 9:17am

It is an “Arduino Nano Every”, VID 2341, PID 0058
I want to change the PID to 0043 an the name “#lighthack”
PIO version Home 3.0.1 and Core 4.1.0 and macOS Catalina 10.15.2
Where can I find the code in system?

sstaub · January 21, 2020, 11:49am

Here the log:
sstaub1:#lighthack USB test sstaub$ pio run -t upload -v

Processing nano_every (platform: atmelmegaavr; board: nano_every; framework: arduino; extra_scripts: pre:custon_hwids.py)
---------------------------------------------------------------------------------------------------------------------------------------
CONFIGURATION: https://docs.platformio.org/page/boards/atmelmegaavr/nano_every.html
PLATFORM: Atmel megaAVR 1.0.0 > Arduino Nano Every
HARDWARE: ATMEGA4809 16MHz, 6KB RAM, 47.50KB Flash
PACKAGES: toolchain-atmelavr 1.70300.191015 (7.3.0), tool-avrdude-megaavr 1.60300.191015 (6.3.0), framework-arduino-megaavr 1.8.5
LDF: Library Dependency Finder -> http://bit.ly/configure-pio-ldf
LDF Modes: Finder ~ chain, Compatibility ~ soft
Found 6 compatible libraries
Scanning dependencies...
Dependency Graph
|-- <OSC> (/Users/sstaub/Dateien/Development/Arduino/#lighthack USB test/lib/OSC)
Building in release mode
MethodWrapper(["checkprogsize"], [".pio/build/nano_every/firmware.elf"])
Advanced Memory Usage is available via "PlatformIO Home > Project Inspect"
DATA:    [=         ]   8.0% (used 489 bytes from 6144 bytes)
PROGRAM: [==        ]  15.3% (used 7450 bytes from 48640 bytes)
.pio/build/nano_every/firmware.elf  :
section                     size      addr
.data                         10   8398848
.text                       7440         0
.rodata                      167     23824
.bss                         479   8398858
.comment                      17         0
.note.gnu.avr.deviceinfo      64         0
.debug_aranges               480         0
.debug_info                12058         0
.debug_abbrev               9172         0
.debug_line                 2899         0
.debug_str                  3979         0
Total                      36765
<lambda>(["upload"], [".pio/build/nano_every/firmware.hex"])
AVAILABLE: jtag2updi
CURRENT: upload_protocol = jtag2updi
BeforeUpload(["upload"], [".pio/build/nano_every/firmware.hex"])
Auto-detected: /dev/cu.usbmodem14301
Forcing reset using 1200bps open/close on port /dev/cu.usbmodem14301
Waiting for the new upload port...
avrdude -v -p atmega4809 -C /Users/sstaub/.platformio/packages/tool-avrdude-megaavr/avrdude.conf -c jtag2updi -D -V -b 115200 -e -P "/dev/cu.usbmodem14301" -U flash:w:.pio/build/nano_every/firmware.hex:i -Ufuse2:w:0x01:m -Ufuse5:w:0xC9:m -Ufuse8:w:0x00:m

avrdude: Version 6.3-20190619
         Copyright (c) 2000-2005 Brian Dean, http://www.bdmicro.com/
         Copyright (c) 2007-2014 Joerg Wunsch

         System wide configuration file is "/Users/sstaub/.platformio/packages/tool-avrdude-megaavr/avrdude.conf"
         User configuration file is "/Users/sstaub/.avrduderc"
         User configuration file does not exist or is not a regular file, skipping

         Using Port                    : /dev/cu.usbmodem14301
         Using Programmer              : jtag2updi
         Overriding Baud Rate          : 115200
JTAG ICE mkII sign-on message:
Communications protocol version: 1
M_MCU:
  boot-loader FW version:        1
  firmware version:              6.00
  hardware version:              1
S_MCU:
  boot-loader FW version:        1
  firmware version:              6.00
  hardware version:              1
Serial number:                   00:00:00:00:00:00
Device ID:                       JTAGICE mkII
         AVR Part                      : ATmega4809
         Chip Erase delay              : 0 us
         PAGEL                         : P00
         BS2                           : P00
         RESET disposition             : dedicated
         RETRY pulse                   : SCK
         serial program mode           : yes
         parallel program mode         : yes
         Timeout                       : 0
         StabDelay                     : 0
         CmdexeDelay                   : 0
         SyncLoops                     : 0
         ByteDelay                     : 0
         PollIndex                     : 0
         PollValue                     : 0x00
         Memory Detail                 :

                                  Block Poll               Page                       Polled
           Memory Type Mode Delay Size  Indx Paged  Size   Size #Pages MinW  MaxW   ReadBack
           ----------- ---- ----- ----- ---- ------ ------ ---- ------ ----- ----- ---------
           signature      0     0     0    0 no          3    0      0     0     0 0x00 0x00
           prodsig        0     0     0    0 no         61   61      0     0     0 0x00 0x00
           fuses          0     0     0    0 no          9    0      0     0     0 0x00 0x00
           fuse0          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           fuse1          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           fuse2          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           fuse4          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           fuse5          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           fuse6          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           fuse7          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           fuse8          0     0     0    0 no          1    0      0     0     0 0x00 0x00
           lock           0     0     0    0 no          1    0      0     0     0 0x00 0x00
           data           0     0     0    0 no          0    0      0     0     0 0x00 0x00
           usersig        0     0     0    0 no         64   64      0     0     0 0x00 0x00
           flash          0     0     0    0 no      49152  128      0     0     0 0x00 0x00
           eeprom         0     0     0    0 no        256   64      0     0     0 0x00 0x00

         Programmer Type : JTAGMKII_PDI
         Description     : JTAGv2 to UPDI bridge
         M_MCU hardware version: 1
         M_MCU firmware version: 6.00
         S_MCU hardware version: 1
         S_MCU firmware version: 6.00
         Serial number:          00:00:00:00:00:00
         Vtarget         : 5.0 V

avrdude: jtagmkII_initialize(): Cannot locate "flash" and "boot" memories in description
avrdude: AVR device initialized and ready to accept instructions

Reading | ################################################## | 100% 0.27s

avrdude: Device signature = 0x1e9651 (probably m4809)
avrdude: erasing chip
avrdude: reading input file ".pio/build/nano_every/firmware.hex"
avrdude: writing flash (7618 bytes):

Writing | ################################################## | 100% 5.55s

avrdude: 7618 bytes of flash written
avrdude: reading input file "0x01"
avrdude: writing fuse2 (1 bytes):

Writing | ################################################## | 100% 0.01s

avrdude: 1 bytes of fuse2 written
avrdude: reading input file "0xC9"
avrdude: writing fuse5 (1 bytes):

Writing | ################################################## | 100% 0.01s

avrdude: 1 bytes of fuse5 written
avrdude: reading input file "0x00"
avrdude: writing fuse8 (1 bytes):

Writing | ################################################## | 100% 0.01s

avrdude: 1 bytes of fuse8 written

avrdude: safemode: Fuses OK (E:FF, H:FF, L:FF)

avrdude done.  Thank you.

==================================================== [SUCCESS] Took 12.95 seconds ====================================================
sstaub1:#lighthack USB test sstaub$

maxgerhardt · January 21, 2020, 1:08pm

The script changes the USB PIDs and VIDs to search for, not the PID and VID of the USB device. This is sent by the USB device in the USB descriptors and you’d have to change the firmware or bootloader in order to change these values. I’m not sure where the bootloader for the Arduino Every is. I think the usecase for these scripts is that, given some devices with a customized VID/PID, you can all connect them at once and flash them in a targeted manner.

ivankravets · January 24, 2020, 12:48pm

build.hwids is incorrect in your case. See docs Redirecting...

It should be an array of [VID, PID] pairs.

sstaub · January 26, 2020, 8:36am

There is a general misunderstood, I want to change the VID/PID of a board itself, not the search for. When I understood right, this must be done by boot loader or other tools.

pfeerick · January 26, 2020, 9:24am

I was thinking that you’d need to alter the bootloader like is done with some other boards, but it might be simpler than that. From the looks of the BSP for the megaAVR, the VID/PID are set compile time

github.com

arduino/ArduinoCore-megaavr/blob/d2d1a2a7bc4654b907427cfb8d1003134fa6b340/platform.txt#L132


      
          tools.avrdude.bootloader.pattern="{cmd.path}" "-C{config.path}" {bootloader.verbose} -p{build.mcu} -c{protocol} {program.extra_params} "-Ufuse2:w:{bootloader.OSCCFG}:m" "-Ufuse5:w:{bootloader.SYSCFG0}:m" "-Ufuse8:w:{bootloader.BOOTEND}:m" "-Uflash:w:{runtime.platform.path}/bootloaders/{bootloader.file}:i"
          
          
tools.avrdude_remote.upload.pattern=/usr/bin/run-avrdude /tmp/sketch.hex {upload.verbose} -p{build.mcu}
          
          
tools.avrdude.upload.network_pattern="{network_cmd}" -address {serial.port} -port 65280 -username arduino -password "{network.password}" -sketch "{build.path}/{build.project_name}.bin" -upload /sketch -d -v
          
          
# USB Default Flags
          # Default blank usb manufacturer will be filled in at compile time
          # - from numeric vendor ID, set to Unknown otherwise
          build.usb_manufacturer="Unknown"
          build.usb_flags=-DUSB_VID={build.vid} -DUSB_PID={build.pid} '-DUSB_MANUFACTURER={build.usb_manufacturer}' '-DUSB_PRODUCT={build.usb_product}'

I don’t have any of the boards, so can’t try it… but perhaps set those two flags (or all four if you want) as platformio.ini build_flags and see if that changes them… and if it does, you’ll probably need to do the PID/VID override for platformio so that it recognises the new IDs.

sstaub · January 28, 2020, 8:52am

This does not work, I tried first.

beninside · May 18, 2020, 12:03am

Same problems here as well.
Just to recap, here’s my platformio.ini config:

[env:teensy2pp]
platform = teensy
board = teensy2pp
framework = arduino
build_flags = -D USB_HID
extra_scripts = pre:custon_hwids.py

and my custon_hwids.py python script file:

Import("env")
board_config = env.BoardConfig()
# should be array of VID:PID pairs
board_config.update("build.hwids", [
    ["0x2341", "0x0243"] # VID, PID ?
])

I have reduced edits to the minimum and followed https://docs.platformio.org/en/latest/projectconf/advanced_scripting.html#override-board-configuration as suggested before but problem still persists.
When I type: lsusb to see all my peripherals I cannot see anything like 2341:0243.
What am I doing wrong ?

PS: python 3.8.2, Arch Linux AMD64, latest PlatformIO inside latest VSCode to date (2020-05)

Thanks
Ben

maxgerhardt · May 18, 2020, 10:37am

Sure you’re not having the same misunderstanding? As it says above

Since you’re using Teensy 2 with the USB-HID code, the PID and VID is hardcoded for you.

github.com

PaulStoffregen/cores/blob/master/usb_hid/usb_private.h#L16-L17


      
          #define VENDOR_ID               0x16C0
          #define PRODUCT_ID              0x0482

Try to first change that in the soruce code (<home folder>\.platformio\package\framework-arduinoteensy\...) and see if that works, then you can still do a custom platform_package or script to change it on the fly.

beninside · May 18, 2020, 10:31pm

Thanks @maxgerhardt, after careful reading your advice I’ve solved it.
I’m fine with current Teensy platform and I’m not that expert (yet) so instead of creating a custom platform_package I have just altered usb_private.h file. After my first successful attempt I’ve scripted it in platformio.ini with something like:

extra_scripts = buildHooks.py

and a 10 lines script to change VID/PID before and after compilation

doon1 · June 11, 2020, 12:31am

Hi @beninside
I have made a simple joystick and controller and have been trying to change the VID, PID, and name on the Teensy LC boards that are being used in them. I am a hardware guy and trying to figure this out is scrambling my brain. I changed the VID, PID, and name in the C:\Program Files (x86)\Arduino\hardware\teensy\avr\cores\usb_hid\usb_private.h file but have had no success in getting the boards to be identified properly. They both are just listed in the device manager as keyboard+mouse+joystick.
Do I have to add anything to the sketch? I’ve read about writing an .ini file but that is so far beyond me.
I’ve been searching for an answer for several weeks now but have yet to find an answer.
Sorry if this is such a noob request but can you help me out?
Thanks
John

beninside · June 11, 2020, 8:58am

Hi @doon1 ,

I have just changed VID,PID defines in usb_private.h to see what happens and it worked, in the same files I’ve also seen descriptions and common information published when I need to collect some usb info (lsusb -v with my OS, but you’ll surely have something like that on Win as well). After that I’ve had some troubles with the Teensy Loader (GUI) and I manually need to reset the Teensy with its button to upload new code.

Now I’ve switched to the cli utility (adding a line in my platformio.ini project file) so when Visual Studio uploads everything I can see output on console without switching to other graphical programs. but I’ve reset VID/PID information to defaults, I’ll do some tests again when I’ll finish real code and real project.

In my final release I’d like to change device descriptions and VID:PID, I’d like to upload new code to device when needed and I don’t want to press reset button to do this. I’ll have more than one teensy device in a closed box without external reset buttons, each Teensy must have different VID:PIDs because they’re doing different things and when I upload my code I’d like to upload to proper device. I still don’t know how to achieve that but hopefully I’ll find a way.

This is something I’ve already had with older AVR devices (ATMega 168,328,…) with V-USB (gcc without Arduino) and avrdude without troubles, I’d like to do the same even if TeensyLoader doesn’t want it.

Still looking information for that, PlatformIO environment is complex but seems to be a really good tool I only need to get “suggested way” and keep it maintainable with more than one device.

I’ll share info when I’ll find something.