|
40 | 40 | ///param linearaddr DCC linear address of accessory |
41 | 41 |
|
42 | 42 | #define AFTER(vpin,timer...) |
43 | | -///brief Wait for sensor activated, then decativated for given time |
| 43 | +///brief Wait for sensor activated, then deactivated for given time |
44 | 44 | ///param vpin Virtual Pin number of sensor |
45 | | -///param timer... optional wait in mS, default 500 |
| 45 | +///param timer... optional wait in ms, default 500 |
46 | 46 |
|
47 | 47 | #define AFTEROVERLOAD(track_id) |
48 | 48 | ///brief Wait for overload to be resolved |
|
87 | 87 | ///brief Wait for sensor active, with timeout. Use IFTIMEOUT to determine whether the AT was satisfied. |
88 | 88 | ///see IFTIMEOUT |
89 | 89 | ///param vpin Sensor pin number |
90 | | -///param timeout_ms Millseconds to wait before timeout |
| 90 | +///param timeout_ms Milliseconds to wait before timeout |
91 | 91 |
|
92 | 92 | #define AUTOMATION(sequence_id,description) |
93 | 93 | ///brief Defines starting point of a sequence that will be shown as an Automation by |
|
110 | 110 | ///param msg Quoted message |
111 | 111 |
|
112 | 112 | #define BUILD_CONSIST(loco_id) |
113 | | -//brief Adds a loco to follow the current loco in a consist |
114 | | -//param loco_id may be negative to indicate loco facing backwards |
| 113 | +///brief Adds a loco to follow the current loco in a consist |
| 114 | +///param loco_id may be negative to indicate loco facing backwards |
115 | 115 |
|
116 | 116 | #define BREAK_CONSIST |
117 | | -//brief Breaks up any consist involving the current loco |
| 117 | +///brief Breaks up any consist involving the current loco |
118 | 118 |
|
119 | 119 | #define CALL(sequence_id) |
120 | 120 | ///brief transfer control to another sequence with expectation to return |
|
136 | 136 | ///see THROW |
137 | 137 |
|
138 | 138 | #define CONFIGURE_SERVO(vpin,pos1,pos2,profile) |
139 | | -///brief setup servo movement parameters for non-turnout |
| 139 | +///brief Set up servo movement parameters for non-turnout |
140 | 140 | ///param vpin must refer to a servo capable pin |
141 | 141 | ///param pos1 SET position of servo |
142 | 142 | ///param pos2 RESET position of servo |
|
149 | 149 | ///param subaddr DCC subaddress |
150 | 150 |
|
151 | 151 | #define DCCX_SIGNAL(signal_id,redAspect,amberAspect,greenAspect) |
152 | | -///brief Dfeine advanced DCC accessory signal with aspects |
| 152 | +///brief Define advanced DCC accessory signal with aspects |
153 | 153 | ///param signal_id DCC Linear address AND Id used for all signal manipulation commands |
154 | 154 |
|
155 | 155 | #define DCC_TURNTABLE(turntable_id,home,description...) |
|
175 | 175 |
|
176 | 176 | #define DELAYRANDOM(mindelay,maxdelay) |
177 | 177 | ///brief Waits for random delay between min and max milliseconds (This is not blocking) |
178 | | -///param mindelay minumum delay in mS |
179 | | -///param maxdelay maximum delay in mS |
| 178 | +///param mindelay minimum delay in ms |
| 179 | +///param maxdelay maximum delay in ms |
180 | 180 |
|
181 | 181 | #define DONE |
182 | 182 | ///brief Stops task loco (if any) and terminates current task |
|
211 | 211 | ///brief obsolete.. no longer needed. Does nothing. |
212 | 212 |
|
213 | 213 | #define EXTT_TURNTABLE(id,vpin,home,description...) |
214 | | -///brief This statement will create the EX‑Turntable turntable/traverser object only, so you will need a separate HAL() statement for an EX‑Turntable device driver. |
| 214 | +///brief Defines the EX‑Turntable turntable/traverser object only, so you will need a separate HAL() statement for an EX‑Turntable device driver. |
215 | 215 | ///param homeAngle the angle of the home position, valid angles are 0 - 3600 |
216 | 216 | ///param quoted description... |
217 | 217 |
|
|
296 | 296 | ///see IF |
297 | 297 |
|
298 | 298 | #define IFRANDOM(percent) |
299 | | -///brief randomly satisfield IF at given percent probability |
| 299 | +///brief randomly satisfied IF at given percent probability |
300 | 300 | ///see IF |
301 | 301 |
|
302 | 302 | #define IFRED(signal_id) |
303 | 303 | ///brief Checks if given signal is in RED state |
304 | 304 | ///see IF |
305 | 305 |
|
306 | 306 | #define IFSTASH(stash_id) |
307 | | -///brief Checks if given stash entry has a non zero value |
| 307 | +///brief Checks if given stash entry has a non-zero value |
308 | 308 | ///see IF |
309 | 309 |
|
310 | 310 | #define IFSTASHED_HERE(stash_id) |
|
337 | 337 | ///param mask Binary mask applied to vpin value |
338 | 338 |
|
339 | 339 | #define IFBITMAP_ANY(vpin,mask) |
340 | | -///brief Checks if vpin pseudo-analog value & mask is non zero |
| 340 | +///brief Checks if vpin pseudo-analog value & mask is non-zero |
341 | 341 | ///see IF |
342 | 342 | ///param mask Binary mask applied to vpin value |
343 | 343 |
|
|
363 | 363 | #define JMRI_SENSOR(vpin,count...) |
364 | 364 | ///brief Defines multiple JMRI `<s>` type sensor feedback definitions each with id matching vpin and INPUT_PULLUP |
365 | 365 | ///param vpin first vpin number |
366 | | -///param count... Number of consecutine VPINS for which to create JMRI sensor feedbacks. Default 1. |
| 366 | +///param count... Number of consecutive VPINS for which to create JMRI sensor feedbacks. Default 1. |
367 | 367 |
|
368 | 368 | #define JMRI_SENSOR_NOPULLUP(vpin,count...) |
369 | 369 | ///brief Defines multiple JMRI `<s>` type sensor feedback definitions each with id matching vpin |
370 | 370 | ///param vpin first vpin number |
371 | | -///param count... Number of consecutine VPINS for which to create JMRI sensor feedbacks. Default 1. |
| 371 | +///param count... Number of consecutive VPINS for which to create JMRI sensor feedbacks. Default 1. |
372 | 372 |
|
373 | 373 | #define JOIN |
374 | 374 | ///brief Switches PROG track to receive MAIN track DCC packets. (Drive on PROG track) |
375 | 375 |
|
376 | 376 | #define KILLALL |
377 | | -///brief Tertminates all running EXRAIL tasks |
| 377 | +///brief Terminates all running EXRAIL tasks |
378 | 378 |
|
379 | 379 | #define LATCH(vpin) |
380 | 380 | ///brief Make all AT/AFTER/IF see vpin as HIGH without checking hardware |
|
392 | 392 | ///param msg Quoted text |
393 | 393 |
|
394 | 394 | #define MOMENTUM(accel,decel...) |
395 | | -///brief sets momentum in mS per DCC 127 step for curent loco. |
| 395 | +///brief sets momentum in ms per DCC 127 step for current loco. |
396 | 396 | ///param accel Acceleration momentum |
397 | | -///param decel... Braking momantum. (=Acceleration if not given) |
| 397 | +///param decel... Braking momentum. (=Acceleration if not given) |
398 | 398 |
|
399 | 399 | #define SCREEN(display,row,msg) |
400 | | -///brief Send message to external display hadlers |
| 400 | +///brief Send message to external display handlers |
401 | 401 | ///param display number, 0=local display, others are handled by external |
402 | 402 | /// displays which may have different display numbers on different devices. |
403 | 403 | ///param msg Quoted text |
|
436 | 436 | ///brief Send MERG CBUS ACOF to Adapter |
437 | 437 |
|
438 | 438 | #define ONACON(eventid) |
439 | | -///brief Start task here when ACON for event receied from MERG CBUS |
| 439 | +///brief Start task here when ACON for event received from MERG CBUS |
440 | 440 |
|
441 | 441 | #define ONACOF(eventid) |
442 | | -///brief Start task here when ACOF for event receied from MERG CBUS |
| 442 | +///brief Start task here when ACOF for event received from MERG CBUS |
443 | 443 |
|
444 | 444 | #define ONACTIVATE(addr,subaddr) |
445 | 445 | ///brief Start task here when DCC Activate sent for short address |
|
515 | 515 | ///brief Start task here when sensor changes HIGH to LOW. |
516 | 516 |
|
517 | 517 | #define PAUSE |
518 | | -///brief Pauses all EXRAIL tasks except the curremnt one. |
| 518 | +///brief Pauses all EXRAIL tasks except the current one. |
519 | 519 | /// Other tasks ESTOP their locos until RESUME issued |
520 | 520 |
|
521 | 521 | #define PIN_TURNOUT(id,vpin,description...) |
522 | | -///brief Defines a turnout which operates on a signle pin |
| 522 | +///brief Defines a turnout which operates on a single pin |
523 | 523 | ///param description... Quoted text (shown to throttles) or HIDDEN |
524 | 524 |
|
525 | 525 | #define PRINT(msg) |
|
609 | 609 | ///param funcmap... Quoted text, optional list of function names separated by / character with momentary function names prefixed with an *. |
610 | 610 |
|
611 | 611 | #define ROUTE(sequence_id,description) |
612 | | -///brief DEfines starting point of a sequence that will appear as a route on throttle buttons. |
613 | | -///param description Quoted text, throttle button capotion. |
| 612 | +///brief Defines starting point of a sequence that will appear as a route on throttle buttons. |
| 613 | +///param description Quoted text, throttle button caption. |
614 | 614 |
|
615 | 615 | #define ROUTE_ACTIVE(sequence_id) |
616 | 616 | ///brief Tells throttle to display the route button as active |
|
642 | 642 | ///param route sequence_id of route, automation or sequence to drive |
643 | 643 |
|
644 | 644 | #define SEQUENCE(sequence_id) |
645 | | -///brief Provides a unique label than can be used to call, follow or start. |
| 645 | +///brief Provides a unique label that can be used to call, follow or start. |
646 | 646 | ///see CALL |
647 | 647 | ///see FOLLOW |
648 | 648 | ///see START |
|
742 | 742 | ///brief Starts a new task at the given route/animation/sequence |
743 | 743 |
|
744 | 744 | #define START_SHARED(sequence_id) |
745 | | -///brief Starts a new task at the given route/animation/sequence an share current loco with it |
| 745 | +///brief Starts a new task at the given route/animation/sequence and share current loco with it |
746 | 746 |
|
747 | 747 | #define START_SEND(sequence_id) |
748 | | -///brief Starts a new task at the given route/animation/sequence an send current loco to it. Remove loco from current task. |
| 748 | +///brief Starts a new task at the given route/animation/sequence and send current loco to it. Remove loco from current task. |
749 | 749 |
|
750 | 750 | #define STASH(stash_id) |
751 | | -///brief saves cuttent tasks loco id in the stash array |
| 751 | +///brief saves current task's loco id in the stash array |
752 | 752 | ///param stash_id position in stash array to save loco id |
753 | 753 |
|
754 | 754 | #define STEALTH(code...) |
755 | 755 | ///brief Allows for embedding raw C++ code in context of current task. |
756 | | -///param code... c++ code to be executed. This requires intimate understanding of the product acrhitecture. |
| 756 | +///param code... c++ code to be executed. This requires intimate understanding of the product architecture. |
757 | 757 |
|
758 | 758 | #define STEALTH_GLOBAL(code...) |
759 | 759 | ///brief Allows for embedding raw c++ code out of context. |
760 | | -///param code... c++ code to be defined. This requires intimate understanding of the product acrhitecture. |
| 760 | +///param code... c++ code to be defined. This requires intimate understanding of the product architecture. |
761 | 761 |
|
762 | 762 | #define STOP |
763 | 763 | ///brief Same as SPEED(0) |
|
783 | 783 | ///param subaddr DCC accessory subaddress |
784 | 784 | ///param description... Quoted text or HIDDEN, appears on throttle buttons |
785 | 785 |
|
786 | | -#define TURNOUTL(tirnout_id,addr,description...) |
787 | | -///brief Defines a DCC accessory turnout with inear address |
| 786 | +#define TURNOUTL(turnout_id,addr,description...) |
| 787 | +///brief Defines a DCC accessory turnout with linear address |
788 | 788 | ///see TURNOUT |
789 | 789 | ///param turnout_id to be used in THROW/CLOSE etc |
790 | 790 | ///param addr DCC accessory linear address |
|
813 | 813 | ///param mask Binary mask to be ANDed with vpin1 value |
814 | 814 |
|
815 | 815 | #define BITMAP_INC(vpin) |
816 | | -///brief Increments poesudo analog value by 1 |
| 816 | +///brief Increments pseudo analog value by 1 |
817 | 817 |
|
818 | 818 | #define BITMAP_DEC(vpin) |
819 | | -///brief Decrements poesudo analog value by 1 (to zero) |
| 819 | +///brief Decrements pseudo analog value by 1 (to zero) |
820 | 820 |
|
821 | 821 | #define BITMAP_OR(vpin1,mask) |
822 | 822 | ///brief Performs a bitwise OR operation on the given vpin analog value and mask. |
|
0 commit comments