1
=== modified file 'README.rst'
2
--- README.rst	2015-03-31 18:50:28 +0000
3
+++ README.rst	2016-04-28 07:57:01 +0000
4
@@ -73,6 +73,24 @@
5
73
	    "13": "off",
73
	    "13": "off",
6
74
	    "14": "off",
74
	    "14": "off",
7
75
	    "15": "off"
75
	    "15": "off"
8
76
	  },
9
77
	  "offsets": {
10
78
	    "0": 0,
11
79
	    "1": 0,
12
80
	    "2": 0,
13
81
	    "3": 0,
14
82
	    "4": 0,
15
83
	    "5": 0,
16
84
	    "6": 0,
17
85
	    "7": 0,
18
86
	    "8": 0,
19
87
	    "9": 0,
20
88
	    "10": 0,
21
89
	    "11": 0,
22
90
	    "12": 0,
23
91
	    "13": 0,
24
92
	    "14": 0,
25
93
	    "15": 0
26
76
	  }
94
	  }
27
77
	}
95
	}
28
78
96
29
@@ -81,7 +99,8 @@
30
81
99
31
82
	$ curl http://127.0.0.1:8000/button/3
100
	$ curl http://127.0.0.1:8000/button/3
32
83
	{
101
	{
34
84
	  "button_states": "off"
102
	  "button_states": "off",
35
103
      "offset": 0
36
85
	}
104
	}
37
86
105
38
87
To set the state of a button, send a POST request with the desired state set, like so::
106
To set the state of a button, send a POST request with the desired state set, like so::
39
@@ -89,6 +108,7 @@
40
89
	$ curl --data state=on http://127.0.0.1:8000/button/3
108
	$ curl --data state=on http://127.0.0.1:8000/button/3
41
90
	{
109
	{
42
91
	  "button_states": "on"
110
	  "button_states": "on"
43
111
      "offset": 0
44
92
	}
112
	}
45
93
113
46
94
..the service returns the new state of the button.
114
..the service returns the new state of the button.
47
@@ -112,6 +132,44 @@
48
112
132
49
113
	$ curl --data state=off http://127.0.0.1:8000/button/0
133
	$ curl --data state=off http://127.0.0.1:8000/button/0
50
114
134
51
135
Setting offsets
52
136
===============
53
137
The default rotation of the servo, along with proper calibration, should 
54
138
push the button on the device in most cases.  However, if adjustments are 
55
139
needed, they can be set for each port separately.::
56
140
57
141
    $ curl localhost:8000/button/3 --data offset=-10
58
142
59
143
A negative offset will cause the servo to rotate more, in order to push the 
60
144
button - effectively pushing it harder. A positive offset will cause the 
61
145
servo to rotate less in order to push the button.  For reference, the default 
62
146
"off" position is at 300, and the default "pressed" position is 193.
63
147
64
148
The environment variable UCI_PHONE_MASHER_CONFIG may be used to specify the 
65
149
path to a json config file for the offsets. It should be formatted like this::
66
150
67
151
    {
68
152
      "0": 0,
69
153
      "1": 0,
70
154
      "2": 0,
71
155
      "3": 0,
72
156
      "4": 0,
73
157
      "5": 0,
74
158
      "6": 0,
75
159
      "7": 0,
76
160
      "8": 0,
77
161
      "9": 0,
78
162
      "10": 0,
79
163
      "11": 0,
80
164
      "12": 0,
81
165
      "13": 0,
82
166
      "14": 0,
83
167
      "15": 0
84
168
    }
85
169
86
170
If the config file is specified in the environment, then any modifications to 
87
171
offsets will automatically be saved to the same file
88
172
89
115
Creating a Bootable Image for Raspberry PI 2
173
Creating a Bootable Image for Raspberry PI 2
90
116
============================================
174
============================================
91
117
175
Status:	Merged
Merged at revision:	15
Proposed branch:	lp:~pwlars/uci-phone-masher/offset-readme
Merge into:	lp:uci-phone-masher
Diff against target:	90 lines (+59/-1) 1 file modified README.rst (+59/-1)
To merge this branch:	bzr merge lp:~pwlars/uci-phone-masher/offset-readme
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Canonical Hardware Certification		2016-04-28	Pending
Review via email: mp+293203@code.launchpad.net