Overview

Version information

This version of SDK has the following functions:

1. Support of X1 series products

2. Support of XC series products

3. Support of CC series products

4. Support of Station series products

5. Support of EX series products

6. Support of sub device products;

7. Support of Sentry product

8. Support of Aegis product

9. Support of Gateway product

10. Support of Keypad products

11. Add devices by QRCode.Applicable products:

    X1 Lite series products

    XC series products

    CC series products

    Sentry products

    EX series products

12. Add sub devices.Applicable products:

    Door Sensor

    Motion Detector

    Door/Window Sensor

    Keypad

    Gateway

13. Add devices by Bluetooth.Applicable products:

    X1

    Aegis

    Home Station

14. Add devices by LAN search.Applicable products:

    Home Station Pro

Apply for SDK voucher

Before using the SDK, please provide the following information to Bosma, and then Bosma will provide users with App ID、App Secret and other credential information. users can use these information to complete the initialization of the SDK.

• Company name, e.g. Bosma
• Name of App, e.g. Bosma
• The package name of the App, such as com.Bosma.demo
• What products do users intend to cooperate with?

SDK introduction

Bosma SDK provides a complete set of product services for our cooperative customers to develop App. Customers can implement their own Applications based on Demo provided by us, or develop their own Applications based on SDK. SDK adopts modular design, and each module is relatively independent and perfect. Customers can choose the following modules according to their needs.

• Bosma Basic: it is the basic tool module of SDK, mainly providing some tool classes to support other modules.
• Bosma Core: it is the business basic module of SDK, the main entrance of SDK and provides support for other modules. It mainly completes SDK initialization, product definition, Bluetooth management, etc,
• Bosma Camera: optional module, which is the protocol implementation of intelligent IPC and intelligent doorbell product line, such as X1 series, XC series, CC series, EX series, station series, etc. If the customer cooperation product contains intelligent IPC and intelligent Doorbell product line, it needs to select this module. Otherwise, there is no need to choose.
• Bosma Lock: optional module, which is the protocol implementation of intelligent door lock product line, such as Aegis, Gateway, Keypad and other products. If the customer cooperation product contains smart door lock product line, users need to select this module. Otherwise, there is no need to choose.
• Bosma Lab: optional module, which is the protocol implementation of Bosma user management and completes the relevant business processing of user management. If the customer his own user system, it is not necessary to select this module.
• Bosma Media: optional module for the completion the audio and video processing of the equipment. If the customer chooses the Bosma Camera module,Bosma media is needed, otherwise it will not be needed.
• Bosma Kit: optional module, which defines the implementation of UI integration and completes the integration of UI and business functions. For example: Bosma assistant, cloud video playback, etc.Note: This module needs to contact Bosma customer service, the SDK does not contain this component.

Integrated SDK network topology

The software system betusersen Bosma and customers needs to be constructed according to the following network topology to realize a sound "device server App" communication network. The following tasks need to be completed:

• The customer's server needs to integrate the Bosma server SDK to connect with Bosma server.
• The customer's App needs to integrate the Bosma App SDK to complete the communication betusersen the App and the device.
• The customer's server needs to integrate AWS MQTT SDK and subscribe to related message services.

Description of each step of the topology diagram:

1. The user logs in to the App and sends a login request to the customer server. After obtaining the ticket returned by the server, the user uses the ticket information to complete the initialization of the SDK.
2. After the customer server receives the user login request, it needs to Apply for the user's ticket from Bosma sever. After obtaining the ticket, it returns the ticket information to App through step 1.
3. App completes the communication betusersen App and device through the functions provided by SDK.
4. When the device detects an event, it pushes the event message to the Bosma server.
5. Bosma server pushes event messages of devices to AWS IoT.
6. The customer server subscribes to the message service of AWS IoT and receives related event messages.
7. When the customer server receives the device event message, it pushes the notification message to the user's mobile phone.