2009-10-07 06:18:42

by Kyungmin Park

[permalink] [raw]
Subject: [PATCH 2/6] Haptic: Documentation for haptic class

Describe the haptic class and how to use

Signed-off-by: Kyungmin Park <[email protected]>
---
Documentation/haptic-class.txt | 20 ++++++++++++++++++++
1 files changed, 20 insertions(+), 0 deletions(-)
create mode 100644 Documentation/haptic-class.txt

diff --git a/Documentation/haptic-class.txt b/Documentation/haptic-class.txt
new file mode 100644
index 0000000..6bee82a
--- /dev/null
+++ b/Documentation/haptic-class.txt
@@ -0,0 +1,20 @@
+
+Haptic handling under Linux
+========================
+
+In its simplest form, the haptic class just allows control of Haptics from
+userspace. Haptic appears in /sys/class/haptic/. The maximum level of the
+haptic is defined in max_level file.
+
+To use simple. it provides the oneshot mode. Give millisecond time to this
+property. It working at given time with pre-defined level.
+Of course, you can adjust the level by setting level property
+
+# echo ${millisecond} > /sys/class/haptic/<device>/oneshot
+
+# echo ${level} > /sys/class/haptic/<device>/level
+
+Also you can enable/disable by setting enable property
+
+# echo 1 > /sys/class/haptic/<device>/level -> Enable
+# echo 0 > /sys/class/haptic/<device>/level -> Disable
--
1.5.3.3


2009-10-07 07:05:48

by Trilok Soni

[permalink] [raw]
Subject: Re: [PATCH 2/6] Haptic: Documentation for haptic class

Hi Kyungmin,

On Wed, Oct 7, 2009 at 11:47 AM, Kyungmin Park
<[email protected]> wrote:
> Describe the haptic class and how to use
>
> Signed-off-by: Kyungmin Park <[email protected]>
> ---
> ?Documentation/haptic-class.txt | ? 20 ++++++++++++++++++++
> ?1 files changed, 20 insertions(+), 0 deletions(-)
> ?create mode 100644 Documentation/haptic-class.txt
>
> diff --git a/Documentation/haptic-class.txt b/Documentation/haptic-class.txt
> new file mode 100644
> index 0000000..6bee82a
> --- /dev/null
> +++ b/Documentation/haptic-class.txt
> @@ -0,0 +1,20 @@
> +
> +Haptic handling under Linux
> +========================
> +
> +In its simplest form, the haptic class just allows control of Haptics from
> +userspace. Haptic appears in /sys/class/haptic/. The maximum level of the
> +haptic is defined in max_level file.
> +
> +To use simple. it provides the oneshot mode. Give millisecond time to this
> +property. It working at given time with pre-defined level.

nit-pick: "To make it simple, it provides the one shot mode. Provide
milliseconds time to
this property, and it will be working for the given time with the
pre-defined level."

Please check if my above statement looks better.

> +Of course, you can adjust the level by setting level property
> +
> +# echo ${millisecond} > /sys/class/haptic/<device>/oneshot
> +
> +# echo ${level} > /sys/class/haptic/<device>/level
> +
> +Also you can enable/disable by setting enable property
> +
> +# echo 1 > /sys/class/haptic/<device>/level ? ?-> Enable
> +# echo 0 > /sys/class/haptic/<device>/level ? ?-> Disable
> --
> 1.5.3.3
>
>



--
---Trilok Soni
http://triloksoni.wordpress.com
http://www.linkedin.com/in/triloksoni

2009-10-07 16:50:35

by Dmitry Torokhov

[permalink] [raw]
Subject: Re: [PATCH 2/6] Haptic: Documentation for haptic class

On Wed, Oct 07, 2009 at 03:17:54PM +0900, Kyungmin Park wrote:
> Describe the haptic class and how to use
>
> Signed-off-by: Kyungmin Park <[email protected]>
> ---
> Documentation/haptic-class.txt | 20 ++++++++++++++++++++
> 1 files changed, 20 insertions(+), 0 deletions(-)
> create mode 100644 Documentation/haptic-class.txt
>
> diff --git a/Documentation/haptic-class.txt b/Documentation/haptic-class.txt
> new file mode 100644
> index 0000000..6bee82a
> --- /dev/null
> +++ b/Documentation/haptic-class.txt
> @@ -0,0 +1,20 @@
> +
> +Haptic handling under Linux
> +========================
> +
> +In its simplest form, the haptic class just allows control of Haptics from
> +userspace. Haptic appears in /sys/class/haptic/. The maximum level of the
> +haptic is defined in max_level file.
> +
> +To use simple. it provides the oneshot mode. Give millisecond time to this
> +property. It working at given time with pre-defined level.
> +Of course, you can adjust the level by setting level property

"The interface is pretty simple - it provides oneshot mode where user
can specify duration of the effect (in milliseconds) and desired level":

> +
> +# echo ${millisecond} > /sys/class/haptic/<device>/oneshot
> +
> +# echo ${level} > /sys/class/haptic/<device>/level
> +
> +Also you can enable/disable by setting enable property
> +

"You can also enable or disable haptics devices by manipulating 'enable'
attribute:"

> +# echo 1 > /sys/class/haptic/<device>/level -> Enable
^^^^^^ enable
> +# echo 0 > /sys/class/haptic/<device>/level -> Disable
^^^^^^

--
Dmitry