Command Syntax
Overview
For xOTA to function properly across multiple devices, a common syntax is used. This syntax is the same across all devices listed in the Devices section of this documentation.
The general layout of this syntax can be broken down to the following:
command@parameter,parameter,parameter
Command
Starting with the command, this is the action you would like xOTA to do (see Services for more information.). Each service has its own unique command, and this is everything to the left of the @ symbol.
Parameters
Following, are the parameters. Each parameter is unique to the command and allows you to provide more information if needed. If you are posting a spot, for example, the parameters would be your park/summit code, frequency, mode and comment.
spot@us1126,ssb,14310,cqcq
However, if you are requesting weather information, the parameters serve the purpose for report options
wx@us0071,hourly,summary
Commands can have a mixture of both required and optional parameters. See the various Services for information on available parameters for each command.
General formatting
Aside from the reserved characters below, no additional symbols are needed when issuing a command. Additionally, no capitalization or spaces are needed at all when interacting with xOTA. This was to potentially make it easier for users to type complex summit or park references from a limited keypad (such as a satellite messenger). Both US-1126 and us1126 will be parsed the same, for example.
As another example, instead of formatting the following command:
spot@W6/SC-323,cw,14060,caling cq
You could simplify the summit reference with
spot@w6sc323,cw,14060,calling cq
Both commands will have the same effect as capitalization and symbol usage is not mandatory.
Reserved Characters
The following are reserved characters used for syntax parsing.
| Character | Name | Purpose |
|---|---|---|
| @ | At | Command/Parameter Deliminator |
| , | Comma | Parameter Separator |
| ` | Backtick | Regex command filter |
These characters were chosen for their ease of use in natural language. One feature being considered is the ability for users to set their own custom reserved characters if these are becoming too much of a burden. If this is something you would be interested in, please let us know: Contact
At (@)
The at @ symbol is responsible for deliminating the break between you command and associated parameters.
Such examples of this include:
spot@us1126,cw,14060
wx@w6/sc-323,summary
This deliminator is only required for commands which require additional parameters to be provided.
For all commands that do not require parameters, the @ can be dropped completely.
Comma (,)
The next reserved symbol is the comma ,. The comma is responsible for separating parameters provided to the command.
Depending on the command, the order of the parameters may also be important
Backtick (`)
The backtick ` is used when devices like to send "extra" data long with your message body. For example, some Spot devices when sending an email will include other, automatically, added text in the email describing where the email originated, metadata, or other non-command data which may lead to a syntax error during parsing.
If this is the case for your device, you may wrap your command in backticks. When a message is received from xOTA, it will first look for any data contained between two backticks, all other text and formatting outside the wrap will be disregarded.
For example. If you were to send a command in the following format:
Some random text `spot@us0071,cw,14061,cqcq` Some more trailing data
Only your spot command, contained within the two backticks, would be recognized and parsed.
Backticks were chosen as the deliminator for this function as it's infrequently used in normal grammar and less likely to be used in such scenarios.
All Commands
| Command | Function | Parameters (required) | Parameters(optional) | Notes |
|---|---|---|---|---|
| spot | Post a new spot | [Park/Summit],[Mode],[Frequency] | [Comment] | To post a new spot. The park/summit code is not case or symbol sensitive. All parameters must be in the order shown |
| wx | Request weather report | [Location] | [Hourly],[Summary] | Location can be Park/Summit code or lat/lon. If using non-text email, summary argument is ignored |
| update | Update your spot | [Activity] | [Mode],[Frequency],[Comment] | Update your existing POTA/SOTA spot. Only provide parameters you wish to update |
| conditions | Request solar report | [] | [] | Get a current proprigation report, and quality of the the bands |
| activity | Current SOTA/POTA activity | [] | [Activity],[Band],[Mode] | Get a list of current spots in accordance to provided filters |
| ping | Service test | [] | [] | Quick test available to confirm your device is working appropriately |
| schedule | Schedule an activiation | [Park/Summit],[Mode],[Frequency] | [Comment] | Schedule an activation for a later date |
| verify | Verify SMS device | [] | [] | Used solely for SMS verification |