RTi Companion Bridge

v1.0 | Custom Control Drivers LLC | customcontroldrivers.com

Bridges RTI macros to the RTi Companion mobile app (Android phone + Android Auto) via a hosted cloud relay. The driver opens an outbound TCP/TLS connection to the relay; companion apps connect via WebSocket. State flows both ways through generic Bool/Int/String slots and numeric command triggers.

LICENCING

This driver is a free download. Ongoing use requires a $5/month RTi Companion subscription from customcontroldrivers.com - the subscription keeps the cloud relay (which the driver and the homeowner's phone both connect through) online and the customer's account active.

A 120-minute trial starts the instant the driver first loads on a processor (wall-clock, independent of connection state or subscription status). After the trial expires the driver stops sending updates to the apps until a valid Licence Key is pasted into the Licence category of Driver Configuration Properties. If the subscription lapses, the relay refuses the driver's connection until the customer reactivates at customcontroldrivers.com/account.

The Licence Key is RSA-signed and bound to the master processor's MAC address - it will not work on a different processor. To swap processors, sign in to customcontroldrivers.com/account and email support for a re-issued licence.

SETUP

1. Subscribe at customcontroldrivers.com/drivers/rti-companion ($5/month). The welcome email contains:

- Relay Host, Relay Port, Use TLS (relay connection settings)

- Project ID and Pairing Token (per-customer secrets)

- Licence Key (MAC-bound to the processor)

- 'Pair this phone' button that auto-fills the RTi Companion app when tapped from the homeowner's Android phone (one tap from Gmail, no QR code or manual entry)

The customer can also re-find these values any time at customcontroldrivers.com/account.

2. In Driver Properties > Relay Connection: paste Project ID and Pairing Token from the email. Leave Relay Host / Port / TLS at the defaults (already pointing at the public cloud relay).

3. In Driver Properties > Licence: paste the Licence Key from the email.

4. (Optional) Fill in Command Names for each command you plan to use. Names are limited to 25 characters so the same label fits everywhere - phone, Android Auto, and the On Command N event row in this driver.

5. Download to processor. The Connection State sysvar should flip to Connected within a couple of seconds. Licence Status sysvar should read 'Licensed' (or 'Trial: NN min remaining' if you have not entered a Licence Key yet, or 'Subscription required' if the relay refused the connection because the sub is inactive).

6. On the homeowner's Android phone: install RTi Companion from the Play Store, open the welcome email in Gmail, and tap 'Pair this phone'. The app opens directly and auto-fills its relay settings - no manual setup in the app is required.

USING IN PROGRAMMING

Outbound (RTI -> apps):

Set Bool N - boolean state slots (SetBool01..SetBool36)

Set Int N - integer state slots (SetInt01..SetInt36)

Set String N - free-form text slots (SetString01..SetString36)

Force Reconnect - drops and reopens the relay socket

Send Raw JSON - escape hatch for unmodeled messages

Inbound (apps -> RTI) - two ways to bind macros:

Option A: Bind a macro to an On Command N system event. Fires immediately when the relay sends a trigger with that cmdId. Best for fixed command-to-action mappings.

Option B: Bind a macro to LastTriggerCmdId sysvar change. The macro reads the sysvar and decides what to do. The driver pulses the sysvar on every trigger (writes 0 then writes the new value) so back-to-back same-cmdId triggers still fire sysvar-change events. Best for dynamic dispatch from a single macro.

In both cases LastTriggerPayload sysvar holds the optional string payload.

SYSVARS

ConnectionState, ConnectionState00/01 - connection status booleans

Bool01..Bool36, Int01..Int36, String01..String36 - slot values

SessionId, AppCount - relay session info

LastError - most recent error message

LastTriggerCmdId - last command id received (pulses 0 -> N)

LastTriggerPayload - optional string payload from last trigger

TrialMinutesRemaining - minutes left in the 120-min wall-clock trial (0 once licensed)

LicenceStatus - human-readable licence/trial state

TROUBLESHOOTING

Set Debug Level to Medium or High to log connect/reconnect cycles and inbound/outbound messages.

If ConnectionState stays 0: verify Relay Host is reachable from the processor (default relay.customcontroldrivers.com:7700), TLS is On for the public cloud, and Project ID + Pairing Token match what was emailed at sign-up. The same values can be re-copied any time at customcontroldrivers.com/account.

If LicenceStatus reads 'Subscription required': the relay refused the driver's connection because the RTi Companion subscription is canceled, past due, or unpaid. Reactivate at customcontroldrivers.com/account; the driver will reconnect on its next retry cycle.

If the trial expired and the driver is silent: paste the Licence Key from your welcome email. The licence is MAC-bound to the master processor - if you swap processors, contact support for a re-issued licence.

LastError sysvar shows the most recent failure reason.

Custom Control Drivers LLC - https://customcontroldrivers.com