Difference between revisions of "MC-Basic"

From SoftMC-Wiki
Jump to: navigation, search
m (Contents)
m
Line 1: Line 1:
This manual covers all the commands and properties associated with the software components of the  MC. The application of these commands is covered in the  MC Users Manual. The syntax and related properties and variables are shown for each command. Example are also shown to illustrate the use of the command. It is recommended that you review this manual and refer to it when you are using these functions.
 
 
Various versions of the firmware adds many new features, and in many instances, significantly changes the syntax or behavior of functions (commands, properties). Therefore, the attribute Availability is included in the format to denote the applicability of each function (command, property) to the specified version of the firmware.
 
 
 
== Contents ==
 
== Contents ==
 
* [[:Category:Axystems:MC-Basic:Commands|MC-Basic Commands Reference]] - a list of all MC-Basic commands
 
* [[:Category:Axystems:MC-Basic:Commands|MC-Basic Commands Reference]] - a list of all MC-Basic commands
Line 10: Line 6:
 
* [[Axystems:MC-BASIC Libraries|Libraries]]
 
* [[Axystems:MC-BASIC Libraries|Libraries]]
 
* [[Axystems:MC-BASIC C-Interface|C-Interface]]
 
* [[Axystems:MC-BASIC C-Interface|C-Interface]]
 +
 +
This documentation covers all the commands and properties associated with the software components of the softMC.
 +
<font color="red">
 +
The application of these commands is covered in the  MC Users Manual. The syntax and related properties and variables are shown for each command. Example are also shown to illustrate the use of the command. It is recommended that you review this manual and refer to it when you are using these functions.
 +
</font>
  
 
== Command Reference Format ==
 
== Command Reference Format ==
Each command or property description is clearly separated from adjacent command and property topics so that you can easily find the item that you are looking for.
 
Each description contains sufficient information required to use the command or property correctly. All commands and properties contain the following items:
 
  
 +
Each description contains the information needed for correctly use of the command or property. All commands and properties contain the following items:
 
* Short Form
 
* Short Form
 
* Syntax
 
* Syntax
Line 29: Line 29:
  
 
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.
 
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.
 +
 +
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.
  
 
When parameter values imply dimensional units of measurement, these units are specified in the description of the command or property where they apply.
 
When parameter values imply dimensional units of measurement, these units are specified in the description of the command or property where they apply.
Line 65: Line 67:
  
 
== See also ==
 
== See also ==
* [[Axystems:FAQ MC-Basic|'''FAQ''' MC-Basic]] - Ask a question to the developer
+
* [[Axystems:FAQ MC-Basic|'''FAQ''' MC-Basic]] - Ask the developers a question
 
 
 
* [[Axystems:AMCS Firmware|AMCS Firmware]]
 
* [[Axystems:AMCS Firmware|AMCS Firmware]]
 
 
* [[Axystems:Error Codes|Error Codes]]
 
* [[Axystems:Error Codes|Error Codes]]
 
* [[Axystems:Predefined Constants|Predefined constants]]
 
* [[Axystems:Predefined Constants|Predefined constants]]

Revision as of 10:23, 26 March 2014

Contents

This documentation covers all the commands and properties associated with the software components of the softMC. The application of these commands is covered in the MC Users Manual. The syntax and related properties and variables are shown for each command. Example are also shown to illustrate the use of the command. It is recommended that you review this manual and refer to it when you are using these functions.

Command Reference Format

Each description contains the information needed for correctly use of the command or property. All commands and properties contain the following items:

  • Short Form
  • Syntax
  • Availability
  • Description
  • Type
  • Range
  • Units
  • Default
  • Scope
  • Limitations
  • Example
  • See Also

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.

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.

When parameter values imply dimensional units of measurement, these units are specified in the description of the command or property where they apply.

Notation

In describing the syntax of an instruction, different forms of notation 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 one or another value may be used.

Scope of Operation

Instructions can be executed from any of three contexts: the configuration file (CONFIG.PRG), the terminal, and from 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 of Operation

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.

See also