From: John T. <gi...@gi...> - 2012-01-29 19:56:05
|
Docs: add missing driver Signed-off-by: John Thornton <jth...@gn...> http://git.linuxcnc.org/?p=emc2.git;a=commitdiff;h=f129c60 --- docs/src/Master_Integrator.txt | 2 + docs/src/Master_Integrator_de.txt | 2 + docs/src/Master_Integrator_es.txt | 2 + docs/src/Master_Integrator_pl.txt | 2 + docs/src/Submakefile | 4 ++ docs/src/drivers/shuttlexpress.txt | 60 +++++++++++++++++++++++++++++++++ docs/src/drivers/shuttlexpress_de.txt | 60 +++++++++++++++++++++++++++++++++ docs/src/drivers/shuttlexpress_es.txt | 60 +++++++++++++++++++++++++++++++++ docs/src/drivers/shuttlexpress_pl.txt | 60 +++++++++++++++++++++++++++++++++ docs/src/index.tmpl | 1 + docs/src/index_de.tmpl | 1 + docs/src/index_es.tmpl | 1 + docs/src/index_pl.tmpl | 1 + 13 files changed, 256 insertions(+), 0 deletions(-) diff --git a/docs/src/Master_Integrator.txt b/docs/src/Master_Integrator.txt index b95724c..30bc51a 100644 --- a/docs/src/Master_Integrator.txt +++ b/docs/src/Master_Integrator.txt @@ -79,6 +79,8 @@ include::drivers/pluto_p.txt[] include::drivers/servo_to_go.txt[] +include::drivers/shuttlexpress.txt[] + :leveloffset: 0 = Advanced Topics diff --git a/docs/src/Master_Integrator_de.txt b/docs/src/Master_Integrator_de.txt index 43b0c5b..e3239e5 100644 --- a/docs/src/Master_Integrator_de.txt +++ b/docs/src/Master_Integrator_de.txt @@ -79,6 +79,8 @@ include::drivers/pluto_p_de.txt[] include::drivers/servo_to_go_de.txt[] +include::drivers/shuttlexpress_de.txt[] + :leveloffset: 0 = Advanced Topics diff --git a/docs/src/Master_Integrator_es.txt b/docs/src/Master_Integrator_es.txt index 91a919f..17059e4 100644 --- a/docs/src/Master_Integrator_es.txt +++ b/docs/src/Master_Integrator_es.txt @@ -79,6 +79,8 @@ include::drivers/pluto_p_es.txt[] include::drivers/servo_to_go_es.txt[] +include::drivers/shuttlexpress_es.txt[] + :leveloffset: 0 = Advanced Topics diff --git a/docs/src/Master_Integrator_pl.txt b/docs/src/Master_Integrator_pl.txt index b8136c8..4918fe4 100644 --- a/docs/src/Master_Integrator_pl.txt +++ b/docs/src/Master_Integrator_pl.txt @@ -77,6 +77,8 @@ include::drivers/pluto_p_pl.txt[] include::drivers/servo_to_go_pl.txt[] +include::drivers/shuttlexpress_pl.txt[] + :leveloffset: 0 = Advanced Topics diff --git a/docs/src/Submakefile b/docs/src/Submakefile index c94326b..0ed40c8 100644 --- a/docs/src/Submakefile +++ b/docs/src/Submakefile @@ -171,6 +171,10 @@ DOC_SRCS := \ drivers/servo_to_go_es.txt \ drivers/servo_to_go_fr.txt \ drivers/servo_to_go_pl.txt \ + drivers/suttle-express.txt \ + drivers/suttle-express_es.txt \ + drivers/suttle-express_de.txt \ + drivers/suttle-express_pl.txt \ examples/gcode.txt \ examples/gcode_de.txt \ examples/gcode_es.txt \ diff --git a/docs/src/drivers/shuttlexpress.txt b/docs/src/drivers/shuttlexpress.txt new file mode 100644 index 0000000..186e0fb --- /dev/null +++ b/docs/src/drivers/shuttlexpress.txt @@ -0,0 +1,60 @@ += ShuttleXpress + +[[cha:shuttlexpress]] (((ShuttleXpress))) + +== Description + +shuttlexpress is a userspace HAL component that interfaces Contour Designâs ShuttleXpress device with LinuxCNCâs HAL. The ShuttleXpress has five momentary buttons, a 10 counts/revolution jog wheel with detents, and a 15-position spring-loaded outer wheel that returns to center when released. + +If it is started without command-line arguments, it will probe all /dev/hidraw* device files for ShuttleXpress devices, and use all devices found. If it is started with command-line arguments, only will only probe the devices specified. + +[WARNING] +The ShuttleXpress device has an internal 8-bit counter for the current jog-wheel position. The shuttlexpress driver can not know this value until the ShuttleXpress device sends its first event. When the first event comes into the driver, the driver uses the deviceâs reported jog-wheel position to initialize counts to 0. + +This means that if the first event is generated by a jog-wheel move, that first move will be lost. + +Any user interaction with the ShuttleXpress device will generate an event, informing the driver of the jog-wheel position. So if you (for example) push one of the buttons at startup, the jog-wheel will work fine and notice the first click. + + +== Setup + +The shuttlexpress module needs read permission on the /dev/hidraw* device files. This can be accomplished by adding a file /etc/udev/rules.d/99-shuttlexpress.rules, with the following contents: + +---- +SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0020", MODE="0444" +---- + +== Pins + +(bit out) shuttlexpress.0.button-0 +(bit out) shuttlexpress.0.button-0-not +(bit out) shuttlexpress.0.button-1 +(bit out) shuttlexpress.0.button-1-not +(bit out) shuttlexpress.0.button-2 +(bit out) shuttlexpress.0.button-2-not +(bit out) shuttlexpress.0.button-3 +(bit out) shuttlexpress.0.button-3-not +(bit out) shuttlexpress.0.button-4 +(bit out) shuttlexpress.0.button-4-not + +The five buttons around the outside, starting with the +counter-clockwise-most one. + +(s32 out) shuttlexpress.0.counts + +Accumulated counts from the jog wheel (the inner wheel). + +(s32 out) shuttlexpress.0.spring-wheel-s32 + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, and ranges from -7 at the counter-clockwise +extreme to +7 at the clockwise extreme. + +(float out) shuttlexpress.0.spring-wheel-f + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, -1 at the counter-clockwise extreme, and ++1 at the clockwise extreme. (The ShuttleXpress device reports the +spring-wheel position quantized from -7 to +7, so this pin reports +only 15 discrete values in itâs range.) + diff --git a/docs/src/drivers/shuttlexpress_de.txt b/docs/src/drivers/shuttlexpress_de.txt new file mode 100644 index 0000000..186e0fb --- /dev/null +++ b/docs/src/drivers/shuttlexpress_de.txt @@ -0,0 +1,60 @@ += ShuttleXpress + +[[cha:shuttlexpress]] (((ShuttleXpress))) + +== Description + +shuttlexpress is a userspace HAL component that interfaces Contour Designâs ShuttleXpress device with LinuxCNCâs HAL. The ShuttleXpress has five momentary buttons, a 10 counts/revolution jog wheel with detents, and a 15-position spring-loaded outer wheel that returns to center when released. + +If it is started without command-line arguments, it will probe all /dev/hidraw* device files for ShuttleXpress devices, and use all devices found. If it is started with command-line arguments, only will only probe the devices specified. + +[WARNING] +The ShuttleXpress device has an internal 8-bit counter for the current jog-wheel position. The shuttlexpress driver can not know this value until the ShuttleXpress device sends its first event. When the first event comes into the driver, the driver uses the deviceâs reported jog-wheel position to initialize counts to 0. + +This means that if the first event is generated by a jog-wheel move, that first move will be lost. + +Any user interaction with the ShuttleXpress device will generate an event, informing the driver of the jog-wheel position. So if you (for example) push one of the buttons at startup, the jog-wheel will work fine and notice the first click. + + +== Setup + +The shuttlexpress module needs read permission on the /dev/hidraw* device files. This can be accomplished by adding a file /etc/udev/rules.d/99-shuttlexpress.rules, with the following contents: + +---- +SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0020", MODE="0444" +---- + +== Pins + +(bit out) shuttlexpress.0.button-0 +(bit out) shuttlexpress.0.button-0-not +(bit out) shuttlexpress.0.button-1 +(bit out) shuttlexpress.0.button-1-not +(bit out) shuttlexpress.0.button-2 +(bit out) shuttlexpress.0.button-2-not +(bit out) shuttlexpress.0.button-3 +(bit out) shuttlexpress.0.button-3-not +(bit out) shuttlexpress.0.button-4 +(bit out) shuttlexpress.0.button-4-not + +The five buttons around the outside, starting with the +counter-clockwise-most one. + +(s32 out) shuttlexpress.0.counts + +Accumulated counts from the jog wheel (the inner wheel). + +(s32 out) shuttlexpress.0.spring-wheel-s32 + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, and ranges from -7 at the counter-clockwise +extreme to +7 at the clockwise extreme. + +(float out) shuttlexpress.0.spring-wheel-f + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, -1 at the counter-clockwise extreme, and ++1 at the clockwise extreme. (The ShuttleXpress device reports the +spring-wheel position quantized from -7 to +7, so this pin reports +only 15 discrete values in itâs range.) + diff --git a/docs/src/drivers/shuttlexpress_es.txt b/docs/src/drivers/shuttlexpress_es.txt new file mode 100644 index 0000000..186e0fb --- /dev/null +++ b/docs/src/drivers/shuttlexpress_es.txt @@ -0,0 +1,60 @@ += ShuttleXpress + +[[cha:shuttlexpress]] (((ShuttleXpress))) + +== Description + +shuttlexpress is a userspace HAL component that interfaces Contour Designâs ShuttleXpress device with LinuxCNCâs HAL. The ShuttleXpress has five momentary buttons, a 10 counts/revolution jog wheel with detents, and a 15-position spring-loaded outer wheel that returns to center when released. + +If it is started without command-line arguments, it will probe all /dev/hidraw* device files for ShuttleXpress devices, and use all devices found. If it is started with command-line arguments, only will only probe the devices specified. + +[WARNING] +The ShuttleXpress device has an internal 8-bit counter for the current jog-wheel position. The shuttlexpress driver can not know this value until the ShuttleXpress device sends its first event. When the first event comes into the driver, the driver uses the deviceâs reported jog-wheel position to initialize counts to 0. + +This means that if the first event is generated by a jog-wheel move, that first move will be lost. + +Any user interaction with the ShuttleXpress device will generate an event, informing the driver of the jog-wheel position. So if you (for example) push one of the buttons at startup, the jog-wheel will work fine and notice the first click. + + +== Setup + +The shuttlexpress module needs read permission on the /dev/hidraw* device files. This can be accomplished by adding a file /etc/udev/rules.d/99-shuttlexpress.rules, with the following contents: + +---- +SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0020", MODE="0444" +---- + +== Pins + +(bit out) shuttlexpress.0.button-0 +(bit out) shuttlexpress.0.button-0-not +(bit out) shuttlexpress.0.button-1 +(bit out) shuttlexpress.0.button-1-not +(bit out) shuttlexpress.0.button-2 +(bit out) shuttlexpress.0.button-2-not +(bit out) shuttlexpress.0.button-3 +(bit out) shuttlexpress.0.button-3-not +(bit out) shuttlexpress.0.button-4 +(bit out) shuttlexpress.0.button-4-not + +The five buttons around the outside, starting with the +counter-clockwise-most one. + +(s32 out) shuttlexpress.0.counts + +Accumulated counts from the jog wheel (the inner wheel). + +(s32 out) shuttlexpress.0.spring-wheel-s32 + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, and ranges from -7 at the counter-clockwise +extreme to +7 at the clockwise extreme. + +(float out) shuttlexpress.0.spring-wheel-f + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, -1 at the counter-clockwise extreme, and ++1 at the clockwise extreme. (The ShuttleXpress device reports the +spring-wheel position quantized from -7 to +7, so this pin reports +only 15 discrete values in itâs range.) + diff --git a/docs/src/drivers/shuttlexpress_pl.txt b/docs/src/drivers/shuttlexpress_pl.txt new file mode 100644 index 0000000..186e0fb --- /dev/null +++ b/docs/src/drivers/shuttlexpress_pl.txt @@ -0,0 +1,60 @@ += ShuttleXpress + +[[cha:shuttlexpress]] (((ShuttleXpress))) + +== Description + +shuttlexpress is a userspace HAL component that interfaces Contour Designâs ShuttleXpress device with LinuxCNCâs HAL. The ShuttleXpress has five momentary buttons, a 10 counts/revolution jog wheel with detents, and a 15-position spring-loaded outer wheel that returns to center when released. + +If it is started without command-line arguments, it will probe all /dev/hidraw* device files for ShuttleXpress devices, and use all devices found. If it is started with command-line arguments, only will only probe the devices specified. + +[WARNING] +The ShuttleXpress device has an internal 8-bit counter for the current jog-wheel position. The shuttlexpress driver can not know this value until the ShuttleXpress device sends its first event. When the first event comes into the driver, the driver uses the deviceâs reported jog-wheel position to initialize counts to 0. + +This means that if the first event is generated by a jog-wheel move, that first move will be lost. + +Any user interaction with the ShuttleXpress device will generate an event, informing the driver of the jog-wheel position. So if you (for example) push one of the buttons at startup, the jog-wheel will work fine and notice the first click. + + +== Setup + +The shuttlexpress module needs read permission on the /dev/hidraw* device files. This can be accomplished by adding a file /etc/udev/rules.d/99-shuttlexpress.rules, with the following contents: + +---- +SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0020", MODE="0444" +---- + +== Pins + +(bit out) shuttlexpress.0.button-0 +(bit out) shuttlexpress.0.button-0-not +(bit out) shuttlexpress.0.button-1 +(bit out) shuttlexpress.0.button-1-not +(bit out) shuttlexpress.0.button-2 +(bit out) shuttlexpress.0.button-2-not +(bit out) shuttlexpress.0.button-3 +(bit out) shuttlexpress.0.button-3-not +(bit out) shuttlexpress.0.button-4 +(bit out) shuttlexpress.0.button-4-not + +The five buttons around the outside, starting with the +counter-clockwise-most one. + +(s32 out) shuttlexpress.0.counts + +Accumulated counts from the jog wheel (the inner wheel). + +(s32 out) shuttlexpress.0.spring-wheel-s32 + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, and ranges from -7 at the counter-clockwise +extreme to +7 at the clockwise extreme. + +(float out) shuttlexpress.0.spring-wheel-f + +The current deflection of the spring-wheel (the outer wheel). +Itâs 0 at rest, -1 at the counter-clockwise extreme, and ++1 at the clockwise extreme. (The ShuttleXpress device reports the +spring-wheel position quantized from -7 to +7, so this pin reports +only 15 discrete values in itâs range.) + diff --git a/docs/src/index.tmpl b/docs/src/index.tmpl index a5fc815..b2b483b 100644 --- a/docs/src/index.tmpl +++ b/docs/src/index.tmpl @@ -76,6 +76,7 @@ <LI><A HREF="drivers/pico_ppmc.html">Pico Drivers</A> <LI><A HREF="drivers/pluto_p.html">Pluto P Driver</A> <LI><A HREF="drivers/servo_to_go.html">Servo To Go Driver</A> + <LI><A HREF="drivers/shuttlexpress.html">ShuttleXpress Driver</A> <LI><A HREF="motion/kinematics.html">Kinematics</A> <LI><A HREF="motion/tweaking_steppers.html">Stepper Tuning</A> <LI><A HREF="motion/pid_theory.html">PID theory</A> diff --git a/docs/src/index_de.tmpl b/docs/src/index_de.tmpl index d6905ed..3446801 100644 --- a/docs/src/index_de.tmpl +++ b/docs/src/index_de.tmpl @@ -79,6 +79,7 @@ <LI><A HREF="drivers/pico_ppmc_de.html">Pico Drivers</A> <LI><A HREF="drivers/pluto_p_de.html">Pluto P Driver</A> <LI><A HREF="drivers/servo_to_go_de.html">Servo To Go Driver</A> + <LI><A HREF="drivers/shuttlexpress_de.html">ShuttleXpress Driver</A> <LI><A HREF="motion/kinematics_de.html">Kinematics</A> <LI><A HREF="motion/tweaking_steppers_de.html">Stepper Tuning</A> <LI><A HREF="motion/pid_theory_de.html">PID theory</A> diff --git a/docs/src/index_es.tmpl b/docs/src/index_es.tmpl index cacf594..9eaa215 100644 --- a/docs/src/index_es.tmpl +++ b/docs/src/index_es.tmpl @@ -78,6 +78,7 @@ <LI><A HREF="drivers/pico_ppmc_es.html">Pico Drivers</A> <LI><A HREF="drivers/pluto_p_es.html">Pluto P Driver</A> <LI><A HREF="drivers/servo_to_go_es.html">Servo To Go Driver</A> + <LI><A HREF="drivers/shuttlexpress_es.html">ShuttleXpress Driver</A> <LI><A HREF="motion/kinematics_es.html">Kinematics</A> <LI><A HREF="motion/tweaking_steppers_es.html">Stepper Tuning</A> <LI><A HREF="motion/pid_theory_es.html">PID theory</A> diff --git a/docs/src/index_pl.tmpl b/docs/src/index_pl.tmpl index 257af4d..afd7846 100644 --- a/docs/src/index_pl.tmpl +++ b/docs/src/index_pl.tmpl @@ -76,6 +76,7 @@ <LI><A HREF="drivers/pico_ppmc_pl.html">Pico Drivers</A> <LI><A HREF="drivers/pluto_p_pl.html">Pluto P Driver</A> <LI><A HREF="drivers/servo_to_go_pl.html">Servo To Go Driver</A> + <LI><A HREF="drivers/shuttlexpress_pl.html">ShuttleXpress Driver</A> <LI><A HREF="motion/kinematics_pl.html">Kinematics</A> <LI><A HREF="motion/tweaking_steppers_pl.html">Stepper Tuning</A> <LI><A HREF="motion/pid_theory_pl.html">PID theory</A> |