aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/language.rst
blob: 377287235b3ccdfe157753e6b0bfe6df97898790 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
.. _language:

==========================
 Maple Language Reference
==========================

The Maple can be programmed in a mostly-complete subset of the the
`Wiring <http://www.wiring.org.co/reference/>`_ language, which is the
same language used to program the `Arduino <http://arduino.cc/>`_
boards.  The entire language will be supported in a future release.
Please see the extensive `language reference
<http://arduino.cc/en/Reference/HomePage>`_ on the Arduino webpage for
more information, or follow a direct link below.

Unique Maple Additions
----------------------

``ASSERT(...)``
    The ``ASSERT()`` function can be very useful for basic program
    debugging. The function accepts a boolean; for example:

      ``ASSERT(state == WAIT);``

    zero is false and any other number is true. If the boolean is true
    the assertion passes and the program continues as usual. If it is
    false, the assertion fails: the program is halted, debug
    information is printed to USART2, and the status LED begins to
    throb in intensity (it's noticeably different from blinking). The
    debug information is printed at 9600 baud and consists of the
    filename and line number where the particular assertion failed.

    Including assertions in a program increases the program size. When
    using libmaple **from the command line only**, they can be
    disabled by making the definition

      ``#define DEBUG_LEVEL DEBUG_NONE``

    before including either wirish or libmaple. In this case, all
    assertions will pass without any lost clock cycles.  Note that
    this will **not work in the IDE**; even with this definition,
    assertions will still be enabled.

Arduino Documentation Links
---------------------------

(This table was copied from http://arduino.cc/en/Reference/Extended).

+------------------------------------+------------------------------------+-----------------------------------------+
| Structure                          | Variables                          | Functions                               |
|                                    |                                    |                                         |
+====================================+====================================+=========================================+
|                                    |**Constants**                       |**Digital I/O**                          |
|* `setup()`_                        |                                    |                                         |
|                                    |* `HIGH`_ | `LOW`_                  |* `pinMode()`_                           |
|* `loop()`_                         |                                    |                                         |
|                                    |* `INPUT`_ | `OUTPUT`_              |* `digitalWrite()`_                      |
|                                    |                                    |                                         |
|**Control Structures**              |* `true`_ | `false`_                |* `digitalRead()`_                       |
|                                    |                                    |                                         |
|* `if`_                             |* `integer constants`_              |                                         |
|                                    |                                    |**Analog I/O**                           |
|* `if...else`_                      |* `floating point constants`_       |                                         |
|                                    |                                    |* `analogReference()`_                   |
|* `for`_                            |                                    |                                         |
|                                    |**Data Types**                      |* `analogRead()`_                        |
|* `switch/case`_                    |                                    |                                         |
|                                    |* `void`_                           |* `analogWrite()`_ - PWM                 |
|* `while`_                          |                                    |                                         |
|                                    |* `boolean`_                        |                                         |
|* `do...while`_                     |                                    |**Advanced I/O**                         |
|                                    |* `char`_                           |                                         |
|* `break`_                          |                                    |* `tone()`_                              |
|                                    |* `unsigned char`_                  |                                         |
|* `continue`_                       |                                    |* `noTone()`_                            |
|                                    |* `byte`_                           |                                         |
|* `return`_                         |                                    |* `shiftOut()`_                          |
|                                    |* `int`_                            |                                         |
|* `goto`_                           |                                    |* `pulseIn()`_                           |
|                                    |* `unsigned int`_                   |                                         |
|                                    |                                    |                                         |
|**Further syntax**                  |* `word`_                           |**Time**                                 |
|                                    |                                    |                                         |
|* `;`_ (semicolon)                  |* `long`_                           |* `millis()`_                            |
|                                    |                                    |                                         |
|* `{}`_ (curly braces)              |* `unsigned long`_                  |* `micros()`_                            |
|                                    |                                    |                                         |
|* `//`_ (single line comment)       |* `float`_                          |* `delay()`_                             |
|                                    |                                    |                                         |
|* `/\* \*/`_ (multi-line comment)   |* `double`_                         |* `delayMicroseconds()`_                 |
|                                    |                                    |                                         |
|* `#define`_                        |* `string`_                         |                                         |
|                                    |                                    |**Math**                                 |
|* `#include`_                       |* `array`_                          |                                         |
|                                    |                                    |* `min()`_                               |
|                                    |                                    |                                         |
|**Arithmetic Operators**            |**Conversion**                      |* `max()`_                               |
|                                    |                                    |                                         |
|* `=`_ (assignment operator)        |* `char()`_                         |* `abs()`_                               |
|                                    |                                    |                                         |
|* `+`_ (addition)                   |* `byte()`_                         |* `constrain()`_                         |
|                                    |                                    |                                         |
|* `-`_ (subtraction)                |* `int()`_                          |* `map()`_                               |
|                                    |                                    |                                         |
|* `*`_ (multiplication)             |* `word()`_                         |* `pow()`_                               |
|                                    |                                    |                                         |
|* `/`_ (division)                   |* `long()`_                         |* `sqrt()`_                              |
|                                    |                                    |                                         |
|* `%`_ (modulo)                     |* `float()`_                        |                                         |
|                                    |                                    |**Trigonometry**                         |
|                                    |                                    |                                         |
|**Comparison Operators**            |**Variable Scope & Qualifiers**     |* `sin()`_                               |
|                                    |                                    |                                         |
|* `==`_ (equal to)                  |* `variable scope`_                 |* `cos()`_                               |
|                                    |                                    |                                         |
|* `!=`_ (not equal to)              |* `static`_                         |* `tan()`_                               |
|                                    |                                    |                                         |
|* `<`_ (less than)                  |* `volatile`_                       |                                         |
|                                    |                                    |**Random Numbers**                       |
|* `>`_ (greater than)               |* `const`_                          |                                         |
|                                    |                                    |* `randomSeed()`_                        |
|* `<=`_ (less than or equal to)     |                                    |                                         |
|                                    |**Utilities**                       |* `random()`_                            |
|* `>=`_ (greater than or equal to)  |                                    |                                         |
|                                    |* `sizeof()`_ (sizeof operator)     |                                         |
|                                    |                                    |**Bits and Bytes**                       |
|**Boolean Operators**               |                                    |                                         |
|                                    |                                    |* `lowByte()`_                           |
|* `&&`_ (and)                       |                                    |                                         |
|                                    |                                    |* `highByte()`_                          |
|* `||`_ (or)                        |                                    |                                         |
|                                    |                                    |* `bitRead()`_                           |
|* `!`_ (not)                        |                                    |                                         |
|                                    |                                    |* `bitWrite()`_                          |
|                                    |                                    |                                         |
|**Pointer Access Operators**        |                                    |* `bitSet()`_                            |
|                                    |                                    |                                         |
|* `* dereference operator`_         |                                    |* `bitClear()`_                          |
|                                    |                                    |                                         |
|* `& reference operator`_           |                                    |* `bit()`_                               |
|                                    |                                    |                                         |
|                                    |                                    |                                         |
|**Bitwise Operators**               |                                    |**External Interrupts**                  |
|                                    |                                    |                                         |
|* `&`_ (bitwise and)                |                                    |For more information on external         |
|                                    |                                    |interrupts on Maple, see                 |
|* `|`_ (bitwise or)                 |                                    |`our reference page`_.                   |
|                                    |                                    |                                         |
|* `^`_ (bitwise xor)                |                                    |                                         |
|                                    |                                    |* `attachInterrupt()`_                   |
|* `~`_ (bitwise not)                |                                    |                                         |
|                                    |                                    |* `detachInterrupt()`_                   |
|* `<<`_ (shift left)                |                                    |                                         |
|                                    |                                    |                                         |
|* `>>`_ (shift right)               |                                    |**Interrupts**                           |
|                                    |                                    |                                         |
|                                    |                                    |* `interrupts()`_                        |
|**Compound Operators**              |                                    |                                         |
|                                    |                                    |* `noInterrupts()`_                      |
|* `++`_ (increment)                 |                                    |                                         |
|                                    |                                    |                                         |
|* `- -`_ (decrement)                |                                    |**Communication**                        |
|                                    |                                    |                                         |
|* `+=`_ (compound addition)         |                                    |* `Serial`_                              |
|                                    |                                    |                                         |
|* `-=`_ (compound subtraction)      |                                    |**Looking for something else?**          |
|                                    |                                    |                                         |
|* `*=`_ (compound multiplication)   |                                    |See the :ref:`libraries` page for        |
|                                    |                                    |interfacing with particular types of     |
|* `/=`_ (compound division)         |                                    |hardware. Try the list of                |
|                                    |                                    |`community-contributed code`_.  Maple    |
|* `&=`_ (compound bitwise and)      |                                    |links against `newlib`_ and allows the   |
|                                    |                                    |use of any of its functions; see its     |
|* `|=`_ (compound bitwise or)       |                                    |documentation for more details.          |
|                                    |                                    |                                         |
+------------------------------------+------------------------------------+-----------------------------------------+

.. _setup(): http://arduino.cc/en/Reference/Setup
.. _loop(): http://arduino.cc/en/Reference/Loop
.. _if: http://arduino.cc/en/Reference/If
.. _if...else: http://arduino.cc/en/Reference/Else
.. _for: http://arduino.cc/en/Reference/For
.. _switch/case: http://arduino.cc/en/Reference/SwitchCase
.. _while: http://arduino.cc/en/Reference/While
.. _do...while: http://arduino.cc/en/Reference/DoWhile
.. _break: http://arduino.cc/en/Reference/Break
.. _continue: http://arduino.cc/en/Reference/Continue
.. _return: http://arduino.cc/en/Reference/Return
.. _goto: http://arduino.cc/en/Reference/Goto

.. _;: http://arduino.cc/en/Reference/SemiColon
.. _{}: http://arduino.cc/en/Reference/Braces
.. _//: http://arduino.cc/en/Reference/Comments
.. _/\* \*/: http://arduino.cc/en/Reference/Comments
.. _#define: http://arduino.cc/en/Reference/Define
.. _#include: http://arduino.cc/en/Reference/Include

.. _=: http://arduino.cc/en/Reference/Assignment
.. _+: http://arduino.cc/en/Reference/Arithmetic
.. _-: http://arduino.cc/en/Reference/Arithmetic
.. _*: http://arduino.cc/en/Reference/Arithmetic
.. _/: http://arduino.cc/en/Reference/Arithmetic
.. _%: http://arduino.cc/en/Reference/Modulo

.. _==: http://arduino.cc/en/Reference/If
.. _!=: http://arduino.cc/en/Reference/If
.. _<: http://arduino.cc/en/Reference/If
.. _>: http://arduino.cc/en/Reference/If
.. _<=: http://arduino.cc/en/Reference/If
.. _>=: http://arduino.cc/en/Reference/If

.. _&&: http://arduino.cc/en/Reference/Boolean
.. _||: http://arduino.cc/en/Reference/Boolean
.. _!: http://arduino.cc/en/Reference/Boolean

.. _* dereference operator: http://arduino.cc/en/Reference/Pointer
.. _& reference operator: http://arduino.cc/en/Reference/Pointer

.. _&: http://arduino.cc/en/Reference/BitwiseAnd
.. _|: http://arduino.cc/en/Reference/BitwiseAnd
.. _^: http://arduino.cc/en/Reference/BitwiseAnd
.. _~: http://arduino.cc/en/Reference/BitwiseXorNot
.. _<<: http://arduino.cc/en/Reference/Bitshift
.. _>>: http://arduino.cc/en/Reference/Bitshift

.. _++: http://arduino.cc/en/Reference/Increment
.. FIXME can't freaking get two hyphens to show up! sphinx turns "--"
.. into an endash, whatever, fine, try to escape like "\-\-", that
.. ALSO becomes endash (!@#$), damn, well, maybe someone else is
.. eating my slash, try "\\-\\-", nope, that turns into a motherfing
.. \-\-. i hate everything.
.. _- -: http://arduino.cc/en/Reference/Increment
.. _+=: http://arduino.cc/en/Reference/IncrementCompound
.. _-=: http://arduino.cc/en/Reference/IncrementCompound
.. _*=: http://arduino.cc/en/Reference/IncrementCompound
.. _/=: http://arduino.cc/en/Reference/IncrementCompound
.. _&=: http://arduino.cc/en/Reference/BitwiseCompound
.. _|=: http://arduino.cc/en/Reference/BitwiseCompound

.. _HIGH: http://arduino.cc/en/Reference/Constants
.. _LOW: http://arduino.cc/en/Reference/Constants
.. _INPUT: http://arduino.cc/en/Reference/Constants
.. _OUTPUT: http://arduino.cc/en/Reference/Constants
.. _true: http://arduino.cc/en/Reference/Constants
.. _false: http://arduino.cc/en/Reference/Constants
.. _integer constants: http://arduino.cc/en/Reference/IntegerConstants
.. _floating point constants: http://arduino.cc/en/Reference/Fpconstants

.. _void: http://arduino.cc/en/Reference/Void
.. _boolean: http://arduino.cc/en/Reference/BooleanVariables
.. _char: http://arduino.cc/en/Reference/Char
.. _unsigned char: http://arduino.cc/en/Reference/UnsignedChar
.. _byte: http://arduino.cc/en/Reference/Byte
.. _int: http://arduino.cc/en/Reference/Int
.. _unsigned int: http://arduino.cc/en/Reference/UnsignedInt
.. _word: http://arduino.cc/en/Reference/Word
.. _long: http://arduino.cc/en/Reference/Long
.. _unsigned long: http://arduino.cc/en/Reference/UnsignedLong
.. _float: http://arduino.cc/en/Reference/Float
.. _double: http://arduino.cc/en/Reference/Double
.. _string: http://arduino.cc/en/Reference/String
.. _array: http://arduino.cc/en/Reference/Array

.. _char(): http://arduino.cc/en/Reference/CharCast
.. _byte(): http://arduino.cc/en/Reference/ByteCast
.. _int(): http://arduino.cc/en/Reference/IntCast
.. _word(): http://arduino.cc/en/Reference/WordCast
.. _long(): http://arduino.cc/en/Reference/LongCast
.. _float(): http://arduino.cc/en/Reference/FloatCast

.. _variable scope: http://arduino.cc/en/Reference/Scope
.. _static: http://arduino.cc/en/Reference/Static
.. _volatile: http://arduino.cc/en/Reference/Volatile
.. _const: http://arduino.cc/en/Reference/Const
.. _sizeof(): http://arduino.cc/en/Reference/Sizeof

.. _pinMode(): http://arduino.cc/en/Reference/PinMode
.. _digitalWrite(): http://arduino.cc/en/Reference/DigitalWrite
.. _digitalRead(): http://arduino.cc/en/Reference/DigitalRead

.. _analogReference(): http://arduino.cc/en/Reference/AnalogReference
.. _analogRead(): http://arduino.cc/en/Reference/AnalogRead
.. _analogWrite(): http://arduino.cc/en/Reference/AnalogWrite

.. _tone(): http://arduino.cc/en/Reference/Tone
.. _noTone(): http://arduino.cc/en/Reference/NoTone
.. _shiftOut(): http://arduino.cc/en/Reference/ShiftOut
.. _pulseIn(): http://arduino.cc/en/Reference/PulseIn

.. _millis(): http://arduino.cc/en/Reference/Millis
.. _micros(): http://arduino.cc/en/Reference/Micros
.. _delay(): http://arduino.cc/en/Reference/Delay
.. _delayMicroseconds(): http://arduino.cc/en/Reference/DelayMicroseconds

.. _min(): http://arduino.cc/en/Reference/Min
.. _max(): http://arduino.cc/en/Reference/Max
.. _abs(): http://arduino.cc/en/Reference/Abs
.. _constrain(): http://arduino.cc/en/Reference/Constrain

.. _map(): http://arduino.cc/en/Reference/Map
.. _pow(): http://arduino.cc/en/Reference/Pow
.. _sqrt(): http://arduino.cc/en/Reference/Sqrt

.. _sin(): http://arduino.cc/en/Reference/Sin
.. _cos(): http://arduino.cc/en/Reference/Cos
.. _tan(): http://arduino.cc/en/Reference/Tan

.. _randomSeed(): http://arduino.cc/en/Reference/RandomSeed
.. _random(): http://arduino.cc/en/Reference/Random

.. _lowByte(): http://arduino.cc/en/Reference/LowByte
.. _highByte(): http://arduino.cc/en/Reference/HighByte
.. _bitRead(): http://arduino.cc/en/Reference/BitRead
.. _bitWrite(): http://arduino.cc/en/Reference/BitWrite
.. _bitSet(): http://arduino.cc/en/Reference/BitSet
.. _bitClear(): http://arduino.cc/en/Reference/BitClear
.. _bit(): http://arduino.cc/en/Reference/Bit

.. _our reference page: http://leaflabs.com/docs/external-interrupts/
.. _attachInterrupt(): http://arduino.cc/en/Reference/AttachInterrupt
.. _detachInterrupt(): http://arduino.cc/en/Reference/DetachInterrupt

.. _interrupts(): http://arduino.cc/en/Reference/Interrupts
.. _noInterrupts(): http://arduino.cc/en/Reference/NoInterrupts

.. _Serial: http://arduino.cc/en/Reference/Serial
.. _community-contributed code: http://www.arduino.cc/playground/Main/GeneralCodeLibrary
.. _newlib: http://sourceware.org/newlib/

Recommended Reading
-------------------

* `newlib Documentation <http://sourceware.org/newlib/>`_
* STMicro documentation for STM32F103RB microcontroller:

    * `All documents <http://www.st.com/mcu/devicedocs-STM32F103RB-110.html>`_
    * `Datasheet (pdf) <http://www.st.com/stonline/products/literature/ds/13587.pdf>`_
    * `Reference Manual (pdf) <http://www.st.com/stonline/products/literature/rm/13902.pdf>`_
    * `Programming Manual (pdf) <http://www.st.com/stonline/products/literature/pm/15491.pdf>`_ (assembly language and register reference)