Commit 124efaad authored by Fernando Herrero's avatar Fernando Herrero
Browse files

Update Readme with user scripts list and usage

parent d22e382d
......@@ -72,20 +72,46 @@ Run the commands on _add repository_ and _add key_ from [labrobotica_how_to inst
## Scripts
When using a CAN to usb adapter, it's neccesary to run *scripts/can.sh*.
This script has the following dependency:
The following scripts located in `./scripts/*.sh` are provided:
- [can-utils](https://elinux.org/Can-utils)
* **can.sh**: necessary when using a CAN to usb adapter
- Dependency: [can-utils](https://elinux.org/Can-utils)
To install it:
sudo apt install can-utils
- Usage:
./can.sh -d <device> -n <name>
-d specify device route. For example, /dev/ttyUSB0"
-n specify human friendly device's name. For example, can0"
* **add_manufacturer_to_group_udev.sh**: adds an udev rule to add manufacturer devices to specified system group.
- Usage:
./add_manufacturer_to_group_udev.sh -m <manufacturer> -g <group> [-f <file>]
-m specify manufacturer. For example, Segway"
-g specify group. For example, dialout"
-f specify udev file. Optional. Default: 99-manufacturer-<manufacturer>-to-group-<group>.rules
* **unbind_ftdi_udev.sh**: adds an udev rule so specified VENDOR:PRODUCT:SERIAL devices do not load *ftdi_sio* driver.
- Usage:
./unbind_ftdi_udev.sh -v <vendor> -p <product> -s <serial> [-f <file>]
-v specify vendor id.
-p specify product id.
-s specify serial number
-f specify udev file. Optional. Default 99-ftdi-unbind-by-serial.rules"
* **undo_unbind_ftdi_udev.sh**: undo the previous script, removing lines from udev rules regarding the specified SERIAL.
- Usage:
./undo_unbind_ftdi_udev.sh -s <serial> [-f <file>]
-s specify serial number
-f specify udev file. Optional. Default 99-ftdi-unbind-by-serial.rules"
```sudo apt install can-utils```
It's also provided a script named *unbind_ftdi_udev.sh* to unload the *ftdi_sio* module and other to undo it (*undo_unbind_ftdi_udev.sh*)
## Disclaimer
Copyright (C) 2009-2018 Institut de Robòtica i Informàtica Industrial, CSIC-UPC.
Copyright (C) Institut de Robòtica i Informàtica Industrial, CSIC-UPC.
Mantainer IRI labrobotics (labrobotica@iri.upc.edu)
This package is distributed in the hope that it will be useful, but without any warranty. It is provided "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. should the program prove defective, the GMR group does not assume the cost of any necessary servicing, repair or correction.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment