Difference between revisions of "MC-Basic"
(→Refer to) |
|||
| (73 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | == | + | == Introduction == |
| − | + | This wiki covers all the commands and properties associated with the software components of the softMC. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | The syntax and related properties and variables are shown for each command. Example are also shown to illustrate the use of the command. | |
| − | |||
| − | |||
| + | == Command Reference Format == | ||
| + | Each entry contains the information needed for correctly use of the command or property. All commands and properties contain the following items: | ||
| + | * Description | ||
* Short Form | * Short Form | ||
* Syntax | * Syntax | ||
* Availability | * Availability | ||
| − | |||
* Type | * Type | ||
* Range | * Range | ||
| Line 24: | Line 18: | ||
* Scope | * Scope | ||
* Limitations | * Limitations | ||
| − | * | + | * Examples |
* See Also | * See Also | ||
| − | Where applicable, a | + | === Short Form === |
| + | Where applicable, a short form of the longer command can be used to simplify typing the command or property name. In such instances, the short form is denoted. The short form of a command or property name may be used interchangeably with the long version. | ||
| + | |||
| + | === Syntax === | ||
| + | In describing the syntax of an instruction, different notations are used. | ||
| + | |||
| + | '''< >'''<br/>Field to be filled by user. For example, ABS ( <expression> ) indicates that <expression> is the user’s data. | ||
| + | |||
| + | '''{ }'''<br/>Optional data. Many instructions have optional fields, which are used to override default values. For example, the VelocityCruise property is optional within a Move command. However, there is an exception to this rule, in that { } are used for vector notation. When the optional data may be repeated, an asterisk (*) is used to indicate this. | ||
| − | + | '''|'''<br/>Or. Indicates that either one of the values may be used. | |
| − | === | + | === Availability === |
| − | + | Various versions of the firmware add new features, and often significantly change the syntax or behavior of commands and properties. The attribute Availability included in the descriptions denotes the applicability of each function (command, property)to the specified version of the firmware. | |
| − | + | === Units === | |
| − | + | When parameter values imply dimensional units of measurement, these units are specified in the description of the command or property where they apply. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | === Scope | + | === Scope === |
| − | Instructions can be executed from any of three contexts: the configuration file (CONFIG.PRG), the terminal, and | + | Instructions can be executed from any of three contexts: the '''configuration''' file (CONFIG.PRG), the '''terminal''', and '''within a task'''. |
Not all instructions can be executed from all three contexts; their scope of operation is limited. For each instruction, the scope of operation is defined. | Not all instructions can be executed from all three contexts; their scope of operation is limited. For each instruction, the scope of operation is defined. | ||
| − | === Limitations | + | === Limitations === |
Even when an instruction can be executed in a given context, there may still be limitations on its use. | Even when an instruction can be executed in a given context, there may still be limitations on its use. | ||
For example, a MOVE command can be executed from within a task, but there is a limitation in that the motion element being moved must first be attached to the task by the ATTACH command. | For example, a MOVE command can be executed from within a task, but there is a limitation in that the motion element being moved must first be attached to the task by the ATTACH command. | ||
| − | == | + | |
| − | + | == Refer to == | |
| − | * MC | + | * [[:Category:MC-Basic:Commands|MC-Basic Commands Reference]] - a list of all MC-Basic commands |
| − | * MC | + | * [[MC-Basic Language Fundamentals|Language Fundamentals]] |
| − | * MC Basic | + | * [[MC-Basic Constants|Constants]] |
| − | * MC/ | + | * [[MC-Basic Arrays|Arrays]] |
| + | * [[MC-Basic Operators|Operators]] | ||
| + | * [[MC-Basic Programs|Programs]] | ||
| + | * [[MC-Basic Libraries|Libraries]] | ||
| + | * [[MC-Basic C-Interface|C-Interface]] | ||
| + | * [[MC-Basic Generic Elements|Generic Elements]] | ||
| + | * [[Error Codes|Error Codes]] | ||
| + | |||
| + | * [[softMC Firmware|softMC Firmware]] - <font color="red"> old main page</font> | ||
| + | |||
| + | == FAQs == | ||
| + | [[FAQ MC-Basic|'''FAQs''' - MC-Basic]] - Ask the developers a question | ||
| − | [[Category | + | [[Category:MC-Basic]] |
| + | [[Category:Control:Offline]] | ||
Latest revision as of 08:37, 21 October 2014
Contents
Introduction
This wiki covers all the commands and properties associated with the software components of the softMC.
The syntax and related properties and variables are shown for each command. Example are also shown to illustrate the use of the command.
Command Reference Format
Each entry contains the information needed for correctly use of the command or property. All commands and properties contain the following items:
- Description
- Short Form
- Syntax
- Availability
- Type
- Range
- Units
- Default
- Scope
- Limitations
- Examples
- See Also
Short Form
Where applicable, a short form of the longer command can be used to simplify typing the command or property name. In such instances, the short form is denoted. The short form of a command or property name may be used interchangeably with the long version.
Syntax
In describing the syntax of an instruction, different notations are used.
< >
Field to be filled by user. For example, ABS ( <expression> ) indicates that <expression> is the user’s data.
{ }
Optional data. Many instructions have optional fields, which are used to override default values. For example, the VelocityCruise property is optional within a Move command. However, there is an exception to this rule, in that { } are used for vector notation. When the optional data may be repeated, an asterisk (*) is used to indicate this.
|
Or. Indicates that either one of the values may be used.
Availability
Various versions of the firmware add new features, and often significantly change the syntax or behavior of commands and properties. The attribute Availability included in the descriptions denotes the applicability of each function (command, property)to the specified version of the firmware.
Units
When parameter values imply dimensional units of measurement, these units are specified in the description of the command or property where they apply.
Scope
Instructions can be executed from any of three contexts: the configuration file (CONFIG.PRG), the terminal, and within a task. Not all instructions can be executed from all three contexts; their scope of operation is limited. For each instruction, the scope of operation is defined.
Limitations
Even when an instruction can be executed in a given context, there may still be limitations on its use. For example, a MOVE command can be executed from within a task, but there is a limitation in that the motion element being moved must first be attached to the task by the ATTACH command.
Refer to
- MC-Basic Commands Reference - a list of all MC-Basic commands
- Language Fundamentals
- Constants
- Arrays
- Operators
- Programs
- Libraries
- C-Interface
- Generic Elements
- Error Codes
- softMC Firmware - old main page
FAQs
FAQs - MC-Basic - Ask the developers a question