Home

Cassia SDK Implementation Guide

This guide shows developers how to use the Cassia RESTful API to integrate their Bluetooth devices with the Cassia IoT Access Controller (AC) and the Cassia Bluetooth routers.

---

NEWS:

v2.0 has been launched! Here are some new API features:

• Enhanced Scan Filter (v2.0 and above)
• RSSI API for Current BLE Connection RSSI (v2.0 and above)
• Numeric Comparison Pairing (v2.0 and above)
• Security OOB Pairing (v2.0 and above)
• Batch Connection API for Faster Mulitple Connection Requests (v2.0 and above)

---

The SDK guide is updated time to time to reflect the latest features. Please view the GitHub Wiki page revisions or contact Cassia Support if you have any questions.

If you would like to verify how the SDK API works, please use the Cassia Bluetooth Debug Tool.

For more information about the Cassia Bluetooth Debug Tool, please visit:
Bluetooth Debug Tool wiki page.

We are looking for any edit suggestions or corrections. Please contact us at:
https://www.cassianetworks.com/support

Table of Contents

Home

Overview

• Cassia Router Overview
• Two Set of RESTful APIs
• Architecture Diagram
• Server-Sent Events

Getting Started

• How to Get Started
• Access Local Router
• Access Cassia Router through the Cassia AC

RESTful API

• Overview of RESTful API
• Common Parameters
• Management API

  • Obtain Cassia Router’s Configuration
  • Obtain Cassia Router’s Status (Through AC)
  • Monitor Cassia Router’s Status (Through AC)
  • Obtain All Online Routers’ Status (Through AC)
  • Reboot a Router Remotely
• Traffic Related API

  • Scan Bluetooth Devices
  • Filter Scanned Data based on Device MAC, RSSI, Name, and UUID
  • Enhanced Scan Filter (v2.0 and above)
  • Connect/Disconnect to a Target Device
  • Batch Connect to a Target Device (v2.0 and above)
  • Discover GATT Services and Characteristics
  • Read/Write the Value of a Specific Characteristic
  • Send Advertise Data
  • Get Device Connection Status
  • Receive Notification and Indication
  • Get RSSI for BLE Connection (v2.0 and above)
• Positioning API
• Secure Pairing API

  • Overview of Secure Pairing API
  • Pair Request
  • Pair-Input Request
  • Unpair Request
  • Just Works Example
  • Passkey Entry Example: Initiator Inputs
  • LE Legacy Pairing OOB Example
  • Numeric Comparison Example (v2.0 and above)
  • Security OOB Example (v2.0 and above)
• Router Auto-Selection API

  • Overview of Router Auto-Selection API
  • Router Auto-Selection
  • Connect a Device
  • Disconnect a Device
• SSE Combination API

  • Overview of SSE Combination API
  • Create Combined SSE
  • Open Scan
  • Close Scan
  • Open Notify
  • Close Notify
  • Open Connection-State Report
  • Close Connection-State Report
  • Open AP-State Report
  • Close AP-State Report

Advanced RESTful API

• BLE 5 Interface Specification
• Secure DFU via Gateway RESTful API
• Pairing API Usage Introduction

MQTT API (Beta Version)

• Change Log
• Overview
• Configuration
• API Invocation
• API Convention
• Gateway Status
• Heartbeat
• BLE API
• Error Codes
• Sample Code

Error Messages

Device Integrating

• Getting Started by Gateway
• Postman Setup for Cassia RESTful API
• Bluetooth Debug Tool

Sample Code

Misc

• Getting Started with Mosquitto MQTT Broker
• Migrate from C1000-2B Firmware to X1000