DISPATCHSET

Installs dispatch messages to enable features and subscriptions

Platform:

OEM719, OEM729, OEM7500, OEM7600, OEM7700, OEM7720, PwrPak7, CPT7, CPT7700, SMART7, SMART2

Firmware:

This command is available only on 7.09.xx firmware.

Specifically on versions 7.09.06 or greater.

The DISPATCHSET command installs dispatch messages to provide feature authorizations and subscriptions to the receiver (1 - Authorization and Subscription). This is used when L-band or NTRIP delivery is not available or direct control is desired. The string form of dispatch messages used by this command is provided through the NovAtel eStore on request after purchase (or trial) or modification of a subscription product or software model. The string begins with the OEM7 card product serial number (PSN), followed by '=', followed by a URL-safe string of ASCII characters from the RFC 4648 base64url character set. The dispatch message can be copied and distributed freely – it applies only to the receiver with the given PSN. The dispatch message includes all subscribed service periods or permanent software models.

Services and receiver features take effect on the first power on or reset after the start date of the service period, or the first one after the message is received for permanent models.

To confirm the messages have been installed, see the DISPATCHSCHEDULE log and VALIDMODELS log.
To retrieve the messages sent to a receiver, use the DISPATCHMESSAGES log. 
To retrieve proof of install, use the DISPATCHRECEIPT log.

DISPATCHSET does not require a SAVECONFIG command. The message is saved immediately.

Dispatch messages are not deleted when a FRESET STANDARD command is issued.

Message ID: 2554

Abbreviated ASCII Syntax:

DISPATCHSET [mode] [dispatch]

ASCII Example:

DISPATCHSET ADD BMHR17090005=bNYWJjZGVmZ2hpamtsbW5vc_HFyc3R1-dnd4eXpBQkNEhp
amtsbW5vcHFyc3R1dnd4eXpBQkNEhpamtsbW5vcHFyc3R1dnd4eXpBQkNE=

 

If an incorrect message is entered, the following response codes may be returned:

  • 271 – RESPONSE_DISPATCH_PSN_MISMATCH – Message is not for this receiver

  • 272 – RESPONSE_DISPATCH_CHECK_FAIL – Message has been corrupted or is incomplete

  • 273 – RESPONSE_DISPATCH_RETIRED – Message is older than the current message

  • 274 – RESPONSE_DISPATCH_INVALID – The content of the message is not understood

  • 275 – RESPONSE_DISPATCH_INVALID_FOR_INPUT – Message is not the right type to input to this receiver

  • 276 – RESPONSE_DISPATCH_INPUT_LOCKED – Too many invalid messages recently, pause a few seconds

  • 281 – RESPONSE_DISPATCH_INVALID_MODEL – A model specified is incompatible with this hardware

  • 285 – RESPONSE_DISPATCH_UNSUPPORTED_SERVICE – A service is not compatible with this firmware version

Field

Field type

ASCII value

Binary value

Description

Format

Binary bytes

Binary offset

1

Command header

–

–

DISPATCHSET header

This field contains the command name for abbreviated ASCII or the message header for ASCII or Binary.

–

H

0

2

mode

ADD

0

Inserts the dispatch string into the receiver as a dispatch message.

Enum

4

H

3

dispatch

Variable length string – up to 2kB

Dispatch message in Offline Dispatch String format.

This message carries a secure authorization message for receiver services and features.

String

Variable

H+4