Update README.md

README.md

@@ -1 +1,99 @@
-# esp32Sx-usb-host-library
+## Info
+
+I would like to announce USB host library for esp32 S2 compatible with arduino, esp-idf and PIO (when pio will be updated to most recent esp-idf).
+I have some working library with simple host example and host mouse example is working too.
+
+I will try to make library more user friendly and maybe in future will add more USB device class (will add CDC for sure).
+Here is example log with connected mouse:
+```
+start
+[   575][I][port.cpp:96] init(): USB host setup properly
+[   575][I][port.cpp:101] init(): Port is power ON now
+[   835][I][mouse.ino:135] port_cb(): PORT event: 1
+[   835][I][mouse.ino:139] port_cb(): physical connection detected
+[   895][I][pipe.cpp:30] USBHostPipe(): constructor
+[   895][I][pipe.cpp:82] init(): Creating pipe
+
+[   895][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 225003
+[   900][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 224903
+[   901][I][mouse.ino:63] ctrl_pipe_cb(): 
+
+[   913][I][mouse.ino:103] ctrl_pipe_cb(): address set: 2
+[   918][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 224923
+[   925][I][mouse.ino:98] ctrl_pipe_cb(): set current configuration: 1
+[   931][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 224923
+
+[   944][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 224667
+[   951][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 224587
+
+
+Config:
+Number of Interfaces: 1
+Attributes: 0xa0
+Max power: 100 mA
+
+Interface:
+bInterfaceNumber: 0
+bAlternateSetting: 0
+bNumEndpoints: 1
+bInterfaceClass: 0x03 (HID)
+bInterfaceSubClass: 0x01
+bInterfaceProtocol: 0x02
+
+Endpoint:
+bEndpointAddress: 0x81
+bmAttributes: 0x03
+bDescriptorType: 5
+wMaxPacketSize: 6
+bInterval: 10 ms
+[   995][I][pipe.cpp:30] USBHostPipe(): constructor
+[   999][I][pipe.cpp:82] init(): Creating pipe
+
+[  1004][I][pipe.cpp:92] init(): EP: 0x3ffc6ecb
+[  1008][I][pipe.cpp:93] init(): EP: 7, 10
+[  1012][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 218651
+[  1019][I][mousepipe.cpp:8] inData(): EP: 0x01
+[  1023][I][mouse.ino:111] ctrl_pipe_cb(): unknown request handled
+[  1029][I][mouse.ino:63] ctrl_pipe_cb(): 
+get descriptor 1: 8704
+[  1035][I][mouse.ino:89] ctrl_pipe_cb(): HID report map
+[ 14405][I][mouse.ino:24] hid_pipe_cb(): 1
+[ 14406][I][mouse.ino:25] hid_pipe_cb(): 0
+[ 14406][I][mouse.ino:26] hid_pipe_cb(): 0/0/0
+[ 14406][I][mouse.ino:27] hid_pipe_cb(): 0
+
+[ 14410][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 219307
+[ 14417][I][mousepipe.cpp:8] inData(): EP: 0x01
+[ 14429][I][mouse.ino:24] hid_pipe_cb(): 1
+[ 14430][I][mouse.ino:25] hid_pipe_cb(): 0
+[ 14430][I][mouse.ino:26] hid_pipe_cb(): 13/160/249
+[ 14434][I][mouse.ino:27] hid_pipe_cb(): 0
+
+[ 14438][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 219315
+[ 14444][I][mousepipe.cpp:8] inData(): EP: 0x01
+[ 14453][I][mouse.ino:24] hid_pipe_cb(): 1
+[ 14454][I][mouse.ino:25] hid_pipe_cb(): 0
+[ 14456][I][mouse.ino:26] hid_pipe_cb(): 5/128/253
+[ 14461][I][mouse.ino:27] hid_pipe_cb(): 0
+
+[ 14465][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 219315
+[ 14472][I][mousepipe.cpp:8] inData(): EP: 0x01
+[ 14477][I][mouse.ino:24] hid_pipe_cb(): 1
+[ 14480][I][mouse.ino:25] hid_pipe_cb(): 0
+[ 14484][I][mouse.ino:26] hid_pipe_cb(): 9/128/251
+[ 14488][I][mouse.ino:27] hid_pipe_cb(): 0
+
+[ 14492][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 219315
+[ 14499][I][mousepipe.cpp:8] inData(): EP: 0x01
+[ 14509][I][mouse.ino:24] hid_pipe_cb(): 1
+[ 14510][I][mouse.ino:25] hid_pipe_cb(): 0
+[ 14511][I][mouse.ino:26] hid_pipe_cb(): 1/224/255
+[ 14516][I][mouse.ino:27] hid_pipe_cb(): 0
+
+[ 14520][I][pipe.cpp:241] allocateIRP(): Creating new IRP, free memory: 219315
+[ 14527][I][mousepipe.cpp:8] inData(): EP: 0x01
+[ 14533][I][mouse.ino:24] hid_pipe_cb(): 1
+[ 14535][I][mouse.ino:25] hid_pipe_cb(): 0
+[ 14538][I][mouse.ino:26] hid_pipe_cb(): 0/0/0
+[ 14543][I][mouse.ino:27] hid_pipe_cb(): 0
+```