ns-usbloader/README.md

35 lines
989 B
Markdown
Raw Normal View History

2019-02-10 04:59:54 +03:00
# NS-USBloader
NS-USBloader is a PC-side tinfoil NSP USB uploader. Replacement for default usb_install_pc.py
With GUI and cookies.
## License
Source code spreads under the GNU General Public License v.3. You can find it in LICENSE file.
2019-02-10 13:07:40 +03:00
## Requirements
JRE 8 or higher.
2019-02-10 04:59:54 +03:00
## Used libraries
* OpenJFX https://wiki.openjdk.java.net/display/OpenJFX/Main
* usb4java: https://mvnrepository.com/artifact/org.usb4java/usb4java
2019-02-10 15:39:44 +03:00
* Few icons taken from: http://materialdesignicons.com/
2019-02-10 04:59:54 +03:00
2019-02-10 17:40:29 +03:00
## Usage
Linux:
2019-02-10 05:01:20 +03:00
2019-02-10 17:40:29 +03:00
`root # java -jar /path/to/NS-USBloader.jar`
2019-02-10 05:01:20 +03:00
2019-02-10 17:40:29 +03:00
## Tips&tricks
### Add user to udev rules to use NS non-root:
`root # vim /etc/udev/rules.d/99-NS.rules`
`SUBSYSTEM=="usb", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="3000", GROUP="plugdev"`
`root # udevadm control --reload-rules && udevadm trigger`
2019-02-10 04:59:54 +03:00
## Known bugs
* Unable to interrupt transmission when libusb awaiting for read event (when user sent NSP list but didn't selected anything on NS).
## TODO:
- [ ] macOS QA
- [ ] Windows support