You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Improvements to Documentation are amazingly helpful, and are very rare so hugely
27
27
28
28
### Functions/Variables
29
29
30
-
If you want to change something in a [built-in function's documentation](http://www.espruino.com/Reference), look at the heading for the function on that page and there will be a right-arrow (⇒).
30
+
If you want to change something in a [built-in function's documentation](http://www.espruino.com/Reference), look at the heading for the function on that page and there will be a right-arrow (⇒).
31
31
32
32
If you click on that it will bring you to the area of Espruino's source code where the function *and the documentation for it* are stored. You can then edit the documentation in that file (above the function) on GitHub and issue a pull request - it's in Markdown format.
* Ensure that you are not contributing someone else's code, and that you are willing to add your code under Espruino's MPL Licence
57
57
* Make sure that what you do doesn't break the Espruino board or the other boards we build for. We can't check all the boards for every commit, so if you break something you'll annoy a whole bunch of people.
58
58
* Be aware that Espruino is designed for Microcontrollers - with very low amounts of flash and memory. Both are at a premium so don't statically allocate variables or do other stuff that will use up RAM.
59
-
* Don't add a whole bunch of indirection/abstraction for the sake of it - it'll probably just use of more of our precious memory.
59
+
* Don't add a whole bunch of indirection/abstraction for the sake of it - it'll probably just use more of our precious memory.
60
60
* If you add a new API, try and make it familiar to Arduino/JavaScript users.
61
61
* Please [RUN THE TESTS](tests/README.md) before and after your changes to check that there are no regressions
62
62
* Finally, please issue us a pull request to [www.github.com/espruino](https://www.github.com/espruino/Espruino) via GitHub. It's way easier for us to incorporate, give credit, and track changes that way.
Copy file name to clipboardExpand all lines: libs/banglejs/jswrap_bangle.c
+6-6
Original file line number
Diff line number
Diff line change
@@ -1835,7 +1835,7 @@ Bangle.setLCDPower(1); // keep screen on
1835
1835
1836
1836
1837
1837
**When on full, the LCD draws roughly 40mA.** You can adjust
1838
-
When brightness using `Bange.setLCDBrightness`.
1838
+
When brightness using `Bangle.setLCDBrightness`.
1839
1839
*/
1840
1840
voidjswrap_banglejs_setLCDPower(boolisOn) {
1841
1841
#ifdefESPR_BACKLIGHT_FADE
@@ -2147,7 +2147,7 @@ Set internal options used for gestures, etc...
2147
2147
* `wakeOnFaceUp` should the LCD turn on when the watch is turned face up? default = `false`
2148
2148
* `wakeOnTouch` should the LCD turn on when the touchscreen is pressed? default = `false`
2149
2149
* `wakeOnTwist` should the LCD turn on when the watch is twisted? default = `true`
2150
-
* `twistThreshold` How much acceleration to register a twist of the watch strap? Can be negative for oppsite direction. default = `800`
2150
+
* `twistThreshold` How much acceleration to register a twist of the watch strap? Can be negative for opposite direction. default = `800`
2151
2151
* `twistMaxY` Maximum acceleration in Y to trigger a twist (low Y means watch is facing the right way up). default = `-800`
2152
2152
* `twistTimeout` How little time (in ms) must a twist take from low->high acceleration? default = `1000`
2153
2153
* `gestureStartThresh` how big a difference before we consider a gesture started? default = `sqr(800)`
@@ -2157,7 +2157,7 @@ Set internal options used for gestures, etc...
2157
2157
* `powerSave` after a minute of not being moved, Bangle.js will change the accelerometer poll interval down to 800ms (10x accelerometer samples).
2158
2158
On movement it'll be raised to the default 80ms. If `Bangle.setPollInterval` is used this is disabled, and for it to work the poll interval
2159
2159
must be either 80ms or 800ms. default = `true`. Setting `powerSave:false` will disable this automatic power saving, but will **not** change
2160
-
the poll interval from its current value. If you desire a specific interval (eg the default 80ms) you must set it manually with `Bangle.setPollInterval(80)`
2160
+
the poll interval from its current value. If you desire a specific interval (e.g. the default 80ms) you must set it manually with `Bangle.setPollInterval(80)`
2161
2161
after setting `powerSave:false`.
2162
2162
* `lockTimeout` how many milliseconds before the screen locks
2163
2163
* `lcdPowerTimeout` how many milliseconds before the screen turns off
@@ -2275,7 +2275,7 @@ int jswrap_banglejs_isLCDOn() {
2275
2275
"ifdef" : "BANGLEJS"
2276
2276
}
2277
2277
This function can be used to lock or unlock Bangle.js
2278
-
(eg whether buttons and touchscreen work or not)
2278
+
(e.g. whether buttons and touchscreen work or not)
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
270
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
271
271
*/
272
272
/*JSON{
273
273
"type" : "constructor",
@@ -287,7 +287,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
290
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
291
291
292
292
Clamped arrays clamp their values to the allowed range, rather than 'wrapping'. e.g. after `a[0]=12345;`, `a[0]==255`.
293
293
*/
@@ -309,7 +309,7 @@ Clamped arrays clamp their values to the allowed range, rather than 'wrapping'.
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
312
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
313
313
*/
314
314
/*JSON{
315
315
"type" : "constructor",
@@ -329,7 +329,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
332
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
333
333
*/
334
334
/*JSON{
335
335
"type" : "constructor",
@@ -349,7 +349,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
352
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
353
353
*/
354
354
/*JSON{
355
355
"type" : "constructor",
@@ -370,7 +370,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
373
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
374
374
*/
375
375
/*JSON{
376
376
"type" : "constructor",
@@ -390,7 +390,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
393
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
394
394
*/
395
395
/*JSON{
396
396
"type" : "constructor",
@@ -410,7 +410,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
413
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
414
414
*/
415
415
/*JSON{
416
416
"type" : "constructor",
@@ -430,7 +430,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
433
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
434
434
*/
435
435
/*JSON{
436
436
"type" : "constructor",
@@ -450,7 +450,7 @@ Create a typed array based on the given input. Either an existing Array Buffer,
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
453
+
Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced.
0 commit comments