Documentation Index

This page provides a comprehensive index of all documentation content organized by page and section headings.

• Home

Radio Controller Hub

• Radio Controller Hub

Getting Started

• Quick Start Guide

• Booking Calendar

  • What the calendar is for
  • Layout overview
  • Layers and what you can see
  • Month, week, and day views
  • Booking colors and visual meaning
  • Availability overlay (focused offering)
  • How to create a booking
  • Block booking
  • Recurring daily booking
  • Time rules the UI respects
  • Conflict visibility and booking prevention
  • Booking details and popups
  • Focused scheduling versus passive browsing
  • Related behavior worth knowing

• Marketplace

  • What you’ll see
  • Find an offering
  • Marketplace favorites (starred offerings)
  • Understand offering cards
  • Connect vs Schedule
  • Auto-extend (when you’re in a session)
  • Cancel a session
  • Multiple iSR Clients
  • Personal notes
  • QR sharing code
  • Related pages

• License Control

  • What it does for you
  • What you need to set up (end user)
  • How it behaves in common situations
  • If something is missing or misconfigured
  • What “license control” is (and isn’t)

In Depth

• In depth: My Shack and clubs
  • How to use this section
  • Related docs
  • Policies

Concepts

• Concepts

  • In this section
  • Guides

• My Shack and clubs

  • My Shack
  • Club
  • Why this matters
  • Next

• Plans and limits

  • Without a paid My Shack plan
  • My Shack — iShareRadio Subscription
  • Club — Club Subscription
  • Changing plans later
  • Next

• Roles vs offerings

  • Roles (Club → Members → Roles)
  • Offerings
  • Share groups
  • Next

• Share groups

  • Where they appear
  • Roles vs share groups (again)
  • Tips
  • Next

My Shack

• My Shack

  • In this section
  • Next

• Choose a My Shack plan

  • Next

• Install the client and pair your first radio

  • Install
  • Pair a radio
  • Next

• Private offering for friends and family

  • Steps
  • Next

• Schedule and operate

  • Where to work
  • Tips
  • Next

• Share an offering with clubs

  • Why this is powerful
  • Next

• List on the Marketplace

  • What changes vs private
  • Money next

• Booking credits and settlement (My Shack)

  • Your role on My Shack
  • Two types of balances
  • Before you can book (policy)
  • Private vs public rates (policy)
  • When money moves: settlement (policy)
  • Ending sessions and disabled offers (policy highlights)
  • Payouts
  • Related

• SMS credits vs booking credits (My Shack)

• Plan changes (My Shack)
  • Smaller plan or migration
  • Cancellation
  • Related

Club owner

• Club owner / admin

  • In this section
  • Next

• Create the club and choose a Club Subscription

  • Next

• Invite and onboard members

  • Owner / admin steps
  • Tips
  • Next

• Define roles

  • Practical pattern
  • Next

• Pair the club fleet

  • Do this on the club
  • Next

• First offerings for members

  • Checklist
  • Next

• Share groups for cohorts

  • Two kinds of share group (pick one)
  • Ideas that work well
  • Next

• Operate and schedule as a club

  • Admin habits that pay off
  • Next

• Monetize club devices

  • Patterns

• Booking credits and settlement (club owner)

  • Club perspective
  • Two types of balances
  • Before members can book paid offerings (policy)
  • Private vs public rates (policy)
  • When money moves: settlement (policy)
  • Ending sessions and disabled offers (policy highlights)
  • Payouts
  • Related

• SMS credits vs booking credits (club owner)

• Plan changes (club owner)
  • Smaller plan or migration
  • Cancellation vs deleting the club
  • Related

Club member

• Club member

  • In this section
  • Next

• Accept the invitation

  • Next

• Book and operate

  • Checklist
  • Next

• Booking credits and settlement (club member)

  • What you need as a booker
  • Settlement (policy, short)
  • Offering credits (you usually skip this)
  • SMS credits
  • Related

• SMS credits vs booking credits (club member)

• Plan changes (club member)
  • Related

Tutorials

• Hub tutorials
• Install iShareRadio Client
• Club owner walkthrough
• Club member walkthrough
• Non member marketplace walkthrough

Flex Radio

• Overview

• [SmartLink](https://www.flexradio.com/documentation/smartlink-quick-start-guide-for-smartsdr-pdf/)

• Connecting the Flex Radio to the Hub

Station Controller

• Control your Shack!

• Installation

• Pairing the Station Controller to the Hub

• HaliKey
  • Purpose
  • CW Operation: NetKeyer and HaliKey
  • Signal and control path
  • CW and Physical PTT

MQTT

• MQTT SaaS

• MQTT clients

  • Prerequisites
  • Publish and subscribe ACL
  • Create an MQTT client (portal)
  • How to set up MQTT topics (platform layout)
  • Connection behaviour
  • Last Will and Testament (LWT)
  • Fixed Vendor Topic Paths
  • Automation (REST API)
  • Related guides

• Deployments

  • Shared vs single-device credentials
  • Plan limits (reporting clients)
  • Vendor fleets
  • Related

• Read-only subscribers

  • When to use them
  • Prerequisites
  • Subscribe filter
  • Topic paths and shared fleet logins
  • Option 1 — Portal (Settings)
  • Option 2 — Mgmt REST API (automation)
  • Using credentials in MQTT clients
  • Troubleshooting
  • Related

• MQTT topic taxonomy and QoS

  • Platform topic format (history, REST, Grafana)
  • MQTT QoS levels (0, 1, 2)
  • Recommended topic classes
  • Guaranteed delivery (QoS 2) add-on
  • Per-client max QoS
  • Portal visibility
  • Retained messages and broker limits
  • iShareRadio client (isr-client)

• Enterprise accounts and teams

  • How it fits together
  • Roles on a tenant
  • Invitations
  • First sign-up
  • Signing in again
  • Switching tenants
  • Automation (Mgmt REST API)
  • What does not change
  • For operators

Client Examples

• Client examples

• Connect ARGUS DL-1 to iShareRadio MQTT

  • Terminology
  • 1. Create Argus DL-1 MQTT credentials
  • 2. Configure Argus DL-1
  • 3. RepeaterBook MQTT Client Credentials
  • History and Grafana
  • 4. Automation (optional)
  • See also

• iSR Client MQTT

  • Topic layout on MQTT SaaS
  • Identified by
  • Telemetry overview
  • Effective QoS on the platform
  • Related guides

• Station Controller MQTT

  • Topic layout
  • Identified by
  • How readings are published
  • Module readings by type
  • Payload envelope (one channel per message)
  • Related guides

REST API

• REST API

  • Guides
  • Related

• REST API tokens

  • Create a token (portal)
  • Refresh / rotate a token
  • Use tokens with add-ons
  • Rate limits and security
  • OpenAPI
  • Related

• MQTT client management API (Mgmt add-on)

  • Before you start
  • List MQTT clients
  • Create an MQTT client
  • Pause, resume, remove
  • Rotate MQTT password
  • Read-only subscribers (listen)
  • Related

• Team and tenant management (Mgmt REST API)

  • Tenants
  • Team members
  • Related

• History REST API (Programmatic History add-on)

• Live REST API (Live add-on)

Dashboard

• Dashboards
• Grafana and InfluxDB
  • What you need first
  • Hosted Grafana {#hosted-grafana}
  • Connect your own Grafana {#connect-your-own-grafana}
  • Example Flux queries {#example-flux-queries}
  • Tags and fields on each point
  • Revoke or rotate a token (BYOG)
  • Troubleshooting
  • Influx organization {#influx-organization}

Support

• Support

  • System Status
  • Getting Help
  • Reference Networking
  • Reporting an issue
  • Additional Resources

• iSR Client GUI Layout

  • Status LEDs Overview
  • Software Download (1)
  • Hub Connection (2)
  • LAN (3)
  • [SmartSDR](https://www.flexradio.com/ssdr) Client Connection (5)
  • Radio Connection (4)
  • Client Type Indicators
  • Understanding Status LED Combinations
  • Info Box and Status Messages
  • Input Fields
  • Using Status LEDs for Troubleshooting
  • Gathering Support Information

iSR Client Installers

• Debian Package Installer
• Windows Installer
• Raspberry Pi Installer
• Station Controller Installer (Raspberry Pi)

About

• About

  • About Us
  • Contact Us

• Icons and Logos

• Donations
• Frequently Asked Questions