SDK BeaconPlus

# BeaconPlus iOS Software Development Kit Guide

**Updating…**

This SDK only support devices based on miniBeaconPlus firmware, il n'est pas compatible avec les appareils précédents, comme iBeacon, Eddystone et etc.. Le SDK BeaconSET+ prend en charge plus de fonctionnalités que le SDK BeaconSET. Nous avons rencontré quelques problèmes dans le processus de développement, Donc, veuillez lire attentivement ce document afin de vous aider à démarrer le plus rapidement possible. En même temps, ce document informera également les notes et les problèmes.

veuillez lire la partie de ce document dont vous avez besoin, partie 1 nous expliquerons l'architecture de ce SDK, partie 2 aidera les développeurs à démarrer, partie 3 expliquera les notes dans vos progrès de développement, partie 4 vous pouvez obtenir des codes d'erreur et des descriptions.

## Design instructions

We divide the communications between SDK and devices into two stages: Étape de numérisation, Étape de connexion. Pour faciliter la compréhension, Jetons un coup d'œil aux classes associées et aux relations entre elles.

**MTCentralManager:** responsable mondial, vérifier l'état Bluetooth du système, écouter les changements de statut, le plus important est de scanner et de se connecter aux appareils;

**MTPériphérique:** instance d'appareils, MTCentralManager créera une instance MTPeripheral pendant qu'il trouverait un périphérique physique, un appareil correspond à une instance. chaque instance MTPeripheral possède une propriété MTFrameHandler et une propriété MTConnectionHandler(Ces deux propriétés sont expliquées ci-dessous);

**MTFrameHandler:** Analyse du cadre publicitaire, il peut analyser toutes les images des données publicitaires d'un appareil. autrement dit, c'est le cœur de l'étape de numérisation;

**MTConnectionHandler:** Opérateur de connexion. cette classe contrôle tout le fonctionnement de l'appareil en phase de connexion.

**Gestionnaire de capteurs MTSensorHandler:** Opérateur de capteur, cette classe contrôle tout le fonctionnement du capteur de l'appareil en phase de connexion.

\*\*MinewFrame:\*\*trame de données, chaque minewframe(ou sous-classe) l'instance correspond à une trame de données, généralement créé par "MTFrameHandler", si un appareil annonce plusieurs trames de données(comme iBeacon, UID, URL) "MTFrameHandler" créera plusieurs instances MinewFrame correspondantes.

**MTOTAManager:** OTA, utilisez cette classe pour mettre à jour le micrologiciel de l'appareil uniquement.

## Structure globale

![BaliseSET+](/ressources/sdksimg/BeaconSET+.3b64ceba.png)

#### Advertisement Stage

in this stage, **MTCentralManager** analysera et analysera les données publicitaires des appareils miniBeaconPlus, **MTCentralManager** créera **"MTPériphérique"** instance pour chaque appareil physique, les développeurs peuvent obtenir toutes les données publicitaires grâce à sa propriété **MTFrameHandler**.

#### Connection Stage

After a **MTPeripheral** connected, le développeur peut apporter certaines modifications à l'appareil par **MTConnectionHandler**(une propriété de l'instance **MTPeripheral**).

#### OTA Operations

In general, Les opérations OTA sont compliquées, nous encapsulons donc le **MTOTAManager** pour effectuer les opérations de mise à jour du firmware, veuillez noter que le développeur ne peut mettre à jour les appareils qu'en état de connexion.

## Commencer

### Préparer

#### Environnement de développement:

-   **Xcode9+**， due to the DFU and Zip Framework based on Swift4.0, so please use Xcode9 or high version to develop;
-   **iOS8**, we limit the minimum iOS system version to 8.0;

### Importer dans le projet

#### Manuellement

1.  copy the framework files to your project folder，include **"MTBeaconPlus.framework"**, **"iOSDFULibrary.framework"**, **"Zip.framework"**, then add them to your project, make sure the **"target"** is checked. as the screenshot below: ![add frameworks](/resources/sdksimg/add_frameworks.8a932d1c.png)
    
2.  find: **"Target"** -> **General** -> **Embedded Binaries**, click the **"+"** ci-dessous, add that 3 framework files. en même temps, assurez-vous de les ajouter à **"Frameworks et bibliothèques liés"**, comme la capture d'écran a explosé:
    
    ![assurez-vous que les cadres](/ressources/sdksimg/make_sure_frameworks.d4466176.png)
    
3.  \*à propos de l'utilisation de Swift, le développeur doit ajouter un **"Objectif C BridgingHeader.h"** fichier au projet(s'il te plaît, fais-le toi-même), puis ajouter **"importer < MTBeaconPlus/MTBeaconPlus.h >"** au fichier.
    
4.  \*en utilisant Objective-C, find: “Target” -> Building Settings -> Always Embed Swift Standard Libraries" ,puis mets oui
    
5.  !!!sur iOS 10 et ci-dessus, Apple ajoute un contrôle d'autorité sur Bluetooth, vous devez ajouter la chaîne à "info.plist" dossier de votre projet: _Confidentialité - Description de l'utilisation du périphérique Bluetooth_ - _"Ta description"_. as the screenshot below.
    
    ![bp_access](/ressources/sdksimg/bp_access.795e088e.png)
    
    6.  !!! Sous iOS13 et supérieur, Apple a ajouté des restrictions d'autorisation sur l'API Bluetooth. Vous devez ajouter une chaîne au fichier info.plist du projet: Confidentialité - Description de l'utilisation de Bluetooth toujours -"Votre description d'utilisation".

### Commencer à développer

##### Get sharedInstance of Manager

First of all, le développeur doit obtenir l'instance partagée du gestionnaire:

```c
// get sharedInstance
MTCentralManager *manager = [Instance partagée MTCentralManager];

// écoutez le changement du bluetooth de l'iPhone
// *** aussi obtenir de "État" propriété.
// *** ce SDK ne fonctionnera normalement que lorsque state == PowerStatePoweredOn!
manager.stateBlock = ^(État de l'état de puissance) {
     NSLog("état actuel du Bluetooth：%d",État);
};
```

##### Scan devices

start scanning task to find devices around you, alors vous pouvez obtenir leur contenu publicitaire, se connecter à l'appareil et modifier les paramètres.

```c
/*
  directeur: instance partagée de MTCentralManager
*/

// démarrer la tâche d'analyse
[gestionnaire startScan:^(NSArray<MTPériphérique *> *péris){
  
   // Traverser le tableau，obtenir une instance de chaque appareil.
   // ** vous pouvez également les afficher sur les vues.
    pour(NSEntier i = 0; je < péris.count; je ++){
        MTPériphérique *peri = péris[je];
        
        // obtenir le FrameHandler d'un appareil.
        // **some properties maybe nil
        MTFrameHandler *framer = peri.framer; 
        NSString *nom = framer.nom;          // nom de l'appareil, may nil
        NSInteger rssi = framer.rssi;          // rssi
        NSInteger battery = framer.battery;    // batterie,may nil
        NSString *mac = framer.mac;            // Adresse Mac,may nil
        NSArray *frames = framer.advFrames;    // toutes les trames de données de l'appareil (telles que:ibalise，UID，URL...)
    }
}];

```

at the sometime, vous pouvez arrêter la tâche d'analyse de cette manière:

```c
/*
  directeur: instance partagée de MTCentralManager
*/

// arrêter la tâche.
[gestionnaire stopScan];
```

now the developer can get all advertisement data of device in this way. Suivant, nous parlerons de la façon d'obtenir des données de trame, comme **iBeacon**, **URL**, **UID** et etc..

Veuillez vous référer à l'exemple de code ci-dessous.

```c
/*
  aFrameHandler: une instance de MTFrameHandler.
*/

NSArray *frames = aFrameHandler.advFrames;
pour (NSEntier i = 0; je < frames.count; je ++){
    MinewFrame *frame = cadres[je];
    
    changer(cadre.frameType){
      cas FrameiBeacon:
        {
          MinewiBeacon *bea = (Minewibalise *)cadre;
          NSLog(@"ibalise:%@, %ld, %ld, %@",bea.uuid, bea.major, bea.mineur, bea.lastUpdate);
        }
           casser;
        
      cas FrameUID:
        {
           MinewUID *uid = (MinewUID *)cadre;
           NSLog(@"UID:%@, %@, %ld, %@", uid.namespaceId, uid.instanceId, uid.txPower, uid.lastUpdate);
        }
           casser;
        
        cas FrameDeviceInfo:
        {
            MinewDeviceInfo *info = (MinewDeviceInfo *)cadre;
            NSLog(@"Info appareil: %ld, %@, %@, %@", (long)info.batterie, info.mac, info.nom, info.lastUpdate);
        }
            casser;
        
        cas FrameTLM:
        {
            MinewTLM *tlm = (MinewTLM *)cadre;
            NSLog(@"TLM: %ld, %F, %ld, %ld, %@", tlm.batteryVol, tlm.température, tlm.advCount, (long)tlm.secCount, tlm.lastUpdate);
        }
            casser;
        
        cas FrameURL:
        {
            MinenouvelleURL *url = (MinenouvelleURL *)cadre;
            NSLog(@"URL: %ld, %@, %@", url.txPower, url.urlString, url.lastUpdate);
        }
            casser;
        
        cas FrameLineBeacon:
        {
            MinewLineBeacon *lineBeacon = (MinewLineBeacon *)cadre;
            // Si nécessaire, VendorKey et lotKey peuvent être obtenus après la connexion par d'autres opérations. Pour plus de détails, se référer à la rubrique "Obtenir les données de chaque canal".
            NSLog(@"Balise de ligne:%@, %@, %@, %ld, %@", lineBeacon.hwId, lineBeacon.authenticationCode, lineBeacon.timestamp, lineBeacon.txPower, lineBeacon.lastUpdate);
        }
            casser;
                    
      /*
         Vous pouvez gérer d'autres types de données si vous en avez besoin. 
      */
    }
}

```

**Important:** pour tous les types de valeurs de capteur, s'il est égal à _MTNAValue_ (une valeur non disponible que nous avons définie, dans le fichier "MTPublicHeader.h"), cela signifie que cette valeur n'est pas disponible.

Veuillez vous référer à l'exemple de code ci-dessous:

```c
/*
    aHT: a MinewHTSensor instance
    aLight: a MinewLightSensor instance
    aAcc：une instance de MinewAccSensor
*/

si (aHT.temperature == MTNAValue) {
    NSLog(@"cette valeur n'est pas disponible.")
}

si (aLight.luxValue == MTNAValue) {
    NSLog(@"cette valeur n'est pas disponible.")
}

si (aAcc.XAxis == MTNAValue) {
    NSLog(@"cette valeur n'est pas disponible.")
}
```

##### Connect to device

Connect to the device in order to do more operations(modifier le paramètre, OTA). vous constaterez que lors de la connexion au mot de passe de l'appareil, vous devrez peut-être, alors le "Blocage de validation du mot de passe" ne doit pas être NULL, sinon l'application plantera!!!!**

Veuillez vous référer à l'exemple de code ci-dessous.

```c
/*
  directeur： a MTCentralManager sharedInstance
  aMTPeripheral： une instance MTPeripheral
*/

// listen the change of device connection state
aMTPeripheral.connector.statusChangeHandler = ^(État de l'état de la connexion, NSErreur *erreur) {
    
    /*
     typedef NS_ENUM(NSEntier, Statut de connexion) {
         StatutConnectFailed = -2,
         StatutDéconnecté = -1,
         StatutNon défini = 0,
         StatutConnexion,
         StatutConnecté,
         StatutLectureInfo,
         StatusDeviceValidating,
         StatutMot de passeValidation,
         StatutSycingTime,
         StatutLectureConnectable,
         Fonctionnalité de lecture d'état,
         StatutReadingFrames,
         StatusReadingTriggers,
         StatusReadingSensorInfo,
         StatutTerminé,
     };
     */
     
    /*
     il y a plusieurs états lors de la connexion à l'appareil,
     seulement "statut == StatutCompleted" signifie le succès des opérations de connexion.
     si une exception apparaît, l'erreur ne sera pas NULL
    */
    
};

// Connectez-vous à l'appareil
// l'aMTPeripheral est une instance de périphérique
// !!!:Avertissement: passwordRequire ne doit pas être NULL!!!
[gestionnaire de connexion au périphérique:aMTMot de passe périphériqueExiger:^(MTPasswordBlock mot de passeBlock){
     // la longueur de la chaîne du mot de passe doit être 8.
    // !!! lire le contenu d'entrée de UITextField comme mot de passe en développement.
    NSString *mot de passe = @"minew123";
    mot de passeBloquer(mot de passe);
}];

// déconnecter de l'appareil.
[gestionnaire déconnexionFromPeriperal:aMTPériphérique];
```

##### Get base information

the developer can get device information and modify parameters when a device connected.

l'exemple de code ci-dessous permet au développeur d'obtenir les données de base de l'appareil.

```c
/*
   aMTPériphérique：une instance MTPeripheral
*/

MTConnectionHandler *con = aMTPeripheral.connector;

Statut de connexion conSte = con.status;  // current connection status
NSDictionary *infoDict = con.infoDict; // Info appareil, tel que：(Version du firmware： 0.9.1）;
NSString *mac = con.macString; // Adresse Mac；
Connectable capable = con.connectable; // appareil connectable，Aucun Inconnu，Pas de désactivation，Yes enable
Version version = con.version; // Version du micrologiciel；
Mot de passeStatus pwdStatus = con.passwordStatus; // mot de passe requis ou non. Aucun, Require

MTConnectionFeature *feature = con.feature; // device features
NSInteger slotAtitude = feature.slotAtitude; // attitude de fente(s), 
FeatureSupported feaSup = feature.featureSupported; // les paramètres peuvent être modifiés：aucun，adv,puissance d'émission,adv/txpower
NSArray<NSNuméro *> *supFrames = feature.supportedSlots; // frames supported（multiple）
NSArray<NSNuméro *> *supTxpower = fonctionnalité.supportedTxpowers; // Txpower supported（multiple）
```

**PS:** **Propriété _Version_ de MTConnectionHandler**.

```c
The version value comes form firmware version， vérifiez la valeur de la version pour connaître les fonctions prises en charge par l'appareil:
 
// init value
VersionUndefined

// version de base, fonction de base uniquement.
VersionBase

// cette version ou supérieure prend en charge le mot de passe de connexion personnalisé et le cadre d'informations sur l'appareil.
Version0_9_8

// cette version ou supérieure prend en charge l'arrêt à distance.
Version0_9_9

// cette version ou supérieure prend en charge les déclencheurs.
Version2_0_0

// cette version ou supérieure prend en charge les déclencheurs avec des configurations avancées.
Version2_2_60

// valeur idéale, prend en charge toutes les fonctionnalités.
VersionMax = 1000
```

##### Get data of each Slot

Next, parlons des données de paramètres de chaque emplacement, la raison pour laquelle nous en parlons est que tout le contenu des paramètres changeants est ici.

**Fente** :Avant de lire le code, parlons de machine à sous, vous pouvez considérer la machine à sous comme un outil publicitaire, il annonce le contenu des données publicitaires même "je ne sais pas" quel est le contenu. comme le 6 les machines à sous pourraient aimer ça:

| Numéro d'emplacement | 0 | 1 | 2 | 3 | 4 | 5 |
| --- | --- | --- | --- | --- | --- | --- |
| Contenu publicitaire | ibalise | TLM | UID | URL | Capteur HT | Aucun |
| Intervalle avancé (ms) | 1000 | 2000 | 500 | 900 | 3000 | 0 |
| RSSI@0/1m（dbm） | \-1 | 0 | \-4 | \-10 | \-3 | 0 |
| Txpower（dbm） | 4 | 0 | \-4 | 4 | 0 | 0 |

Au sens du tableau, le non.0** L'emplacement annoncera les données **iBeacon**, l'emplacement **No.1** annoncera les données **TLM**, …, l'emplacement **No.5** n'annoncera aucune donnée. chacun d'eux a son propre **intervalle de publicité**, **Txpower** et **Calibration RSSI**. Ils sont indépendants les uns des autres.

PS: **RSSI d’étalonnage(RSSI@0/1m)** est le RSSI lorsque l'appareil est à 0/1 m(iBeacon est 1, autres 0).

Comment obtenir les données publicitaires des machines à sous? veuillez vous référer à l'exemple de code ci-dessous.

```c
/*
    escroquer: une instance de MTConnectionHandler
*/

// chaque emplacement a une image de l'appareil actuel.
// l'attitude de ce tableau est égale à l'attitude de l'emplacement(feature.slotAtitude)
// 
// Dans le strict respect de l'ordre du créneau，tel que：0. -> Minewibalise，1. -> MinewUID ...
NSArray<MinewFrame *> *frames = con.allFrames;

/*
   Nous supposons que l'emplacement n°3 contient des données iBeacon, l'emplacement n°4 contient des données UID.
   essayons d'analyser les données de l'emplacement n°3.
*/

// en raison du point par défaut, c'est MinewFrame(la superclasse de MinewiBeacon), nous devons donc faire une conversion.

// get the frame of No.3 slot
MinewFrame *frame = frames[2];

// vérifiez que cet emplacement contient des données iBeacon ou non,
// *Vous ne pouvez pas vérifier si vous confirmez son type.
pour (NSEntier i = 0; je < frames.count; je ++){
MinewFrame *frame = cadres[je];

changer (cadre.frameType) {
cas FrameiBeacon:
{
    MinewiBeacon *iBeacon = (Minewibalise *)cadre;

// iBeacon
    NSString *uuid = iBeacon.uuid;   // uuid
    NSInteger major = iBeacon.major;  // major
    NSInteger minor = iBeacon.minor;  // mineure

// The parameters of the slot
    NSInteger slotNumber = iBeacon.slotNumber;           // number of the slot
    NSInteger slotAdvInterval = iBeacon.slotAdvInterval; // advertisement interval
    NSInteger slotAdvTxpower = iBeacon.slotAdvTxpower;   // ibalise：RSSI@1 million d'autres： RSSI@0m
    NSInteger slotRadioTxpower = iBeacon.slotRadioTxpower; // radio Txpower  
}
    casser;
    
cas FrameURL:
{
    // URL
    MinewURL *url = (MinenouvelleURL *)cadre;
    NSString *urlStr = url.urlString;
    
    // Les paramètres du slot sont obtenus de la même manière
}
    casser;
    
cas FrameUID:
{
    // UID
    MinewUID *uid = (MinewUID *)cadre;
    NSString *namespaceId = uid.namespaceId;
    NSString *instanceId = uid.instanceId;
    
    // Les paramètres du slot sont obtenus de la même manière
}
    casser;

cas FrameLineBeacon:
{
    // Balise de ligne(La méthode d'acquisition est particulière)
    MTLineBeaconData *lineBeaconData = self.currentPeripheral.connector.slotHandler.slotFrameDataDic[ChaîneType de cadre(FrameLineBeacon)];
    NSString *hwid = lineBeaconData.hwId;
    NSString *vendorKey = lineBeaconData.vendorKey;
    NSString *lotKey = lineBeaconData.lotKey;
    
    // Les paramètres du slot sont obtenus de la même manière
}
    casser;
/*
   Vous pouvez gérer d'autres types de données si vous en avez besoin. 
*/
défaut:
    casser;
}
```

You can analyze the data of other slots in the same way, il convient de noter que lorsque **frameType == FrameNone** signifie que l'emplacement n'a pas de données: D'un autre point de vue, cela signifie que cette fente est fermée.

##### Change slot data

The developer can modify advertisement and parameters of every slot freely via our APi.

Nous divisons la trame de données en **trames statiques** et **trames dynamiques**:

-   **Cadre statique**: les données publicitaires ne changeront pas lors de la publicité, comme **iBeacon**, **UID**, **URL**
-   **Cadre dynamique**: les données de la publicité changeront pendant la publicité, tel que **TLM**, **Sensor**

Please refer to the code example below:

```c
/*
   aConnectionHandler:une instance de MTConnectionHandler
*/

// create a uid instance
MinewUID *uid = [[Allouer MinewUID]initialisation];

// ensemble "ID espace de noms" et "ID d'instance" of UID
uid.namespaceId = @"0123456789abdcdcba12";
uid.instanceId = @"0123456789cc";

// the other parameters of slot
uid.slot = 1;  // The number of slot which you want to modify
uid.slotAdvInterval = 600;  // advertisement interval
uid.slotAdvTxpower = -3;    // RSSI@0m
uid.slotRadioTxpower = 4;   // Puissance radio.

// écrire sur l'appareil.
// détail: 1.laisser l'emplacement n°1 annoncer les données UID, ID espace de noms：0123456789abdcdcba12 ID d'instance：0123456789cc
//         2.définir l'intervalle d'annonce du slot n°1 sur 600 ms, RSSI@0m à -3dbm, puissance d'émission radio à 4dbm 
[aConnectionHandler writeFrame:achèvement de l'uid:^(BOOL succès, NSErreur *erreur){
     si (succès) {
        NSLog(@"écrire la trame sur l'appareil avec succès.");   
     } 
     sinon si(erreur) {
        NSLog(@"Erreur:%@", erreur)
     }
}];
```

Becareful, le paramètre slot a des plages:

-   **Intervalle de publicité**: 100 - 5000 (MS)
-   **RSSI@0m**: -127 - 0 (dbm)

**Le plus important**: La puissance radio n'est pas une portée, c'est la note, tel que: -8, -4, 0, 4. vous pouvez obtenir tous les Radio Txpowers pris en charge à partir de la propriété feature du "MTConnectionHandler"

```c
/*
   fonctionnalité: une propriété de MTConnectionHandler.
*/

// obtenir toutes les puissances radio prises en charge par l'appareil actuel.
NSArray<NSNuméro *> *supTx = feature.supportedTxpowers
```

OK, vous pouvez modifier n'importe quel emplacement de la manière ci-dessus, si vous souhaitez fermer un créneau, il suffit de créer une instance **MinewFrame** et de définir sa propriété **frameType** sur **FrameNone**, puis écrivez cette image sur l'appareil. oh, n'oubliez pas de définir un numéro de slot pour le slot que vous souhaitez fermer.

##### Set lineBeacon

The LineBeacon frame needs to call writeFrame method, puis les deux méthodes suivantes sont appelées pour définir le hwid du lineBeacon, clé du fournisseur, et lotKey.

```c
// lotClé:Longueur de 16, largeur de la route:Longueur de 10, clé du fournisseur:Longueur de 8，inclure a-f/A-F/0-9.

// définir le lotKey de LineBeacon
[self.currentPeripheral.connector.slotHandler lineBeaconSetLotkey:@"0011223344556677" achèvement:^(BOOL succès) {
    si (succès) {
        NSLog(@"Définir le succès lotKey de LineBeacon");
    } autre {
        NSLog(@"Échec de la définition du lotKey de LineBeacon");
    }
}];

// définir le hwid de LineBeacon
[self.currentPeripheral.connector.slotHandler lineBeaconSetHWID:@"0011223344" Clé du fournisseur:@"00112233" achèvement:^(BOOL succès) {
    si (succès) {
        NSLog(@"Définir le succès hwid et supplierKey de LineBeacon");
    } autre {
        NSLog(@"La définition du hwid et du supplierKey de LineBeacon a échoué");
    }
}];

```

##### Change global parameter

Global parameter of device is a device level feature, comme connectable, mot de passe requis, réinitialiser par défaut et etc..

Veuillez vous référer à l'exemple de code ci-dessous.

```c
/*
   aConnectionHandler: une instance de MTConnectionHandler
*/
// reset the device
[aConnectionHandler resetFactorySettings:^(BOOL succès, NSErreur *erreur){
    si(succès){
        NSLog(@"Operation success!");
    }
    autre {
        NSLog(@"Opertion failed!");
    }
}];

// update connectable settings
// ConnectableYES: app can connect to the device, ConnectableNO app can't connect to the device.
// if you set connectableNO, you can connect to device by press the button on device maybe next time.
// DANGER!!!:if there is no button on device and set ConnectableNO, l'application ne peut pas se connecter à l'appareil, même pour toujours.
[aConnectionHandler updateConnectable:ConnectableYES completion:^(BOOL succès, NSErreur *erreur){
    si(succès){
        NSLog(@"Operation success!");
    }
    autre {
        NSLog(@"Opertion failed!");
    }
}];

// Modifier/Ajouter un mot de passe
// !!!: la longueur de la chaîne du mot de passe doit être 8, chiffres ou lettres；
// il ajoutera un mot de passe si l'appareil n'a pas de mot de passe, update password if device has a password
[aConnectinoHandler modifyPassword:@"12345678" achèvement:^(BOOL succès, NSErreur *erreur){
    si(succès){
        NSLog(@"Operation success!");
    }
    autre {
        NSLog(@"Opertion failed!");
    }
}];

// remove password
[aConnectionHandler supprimer le mot de passe:^(BOOL succès, NSErreur *erreur){
    si(succès){
        NSLog(@"Operation success!");
    }
    autre {
        NSLog(@"Opertion failed!");
    }
}];

// éteindre l'appareil à distance.
// DANGER!!!: veuillez vous assurer qu'il y a un bouton sur l'appareil, sinon, il risque de ne pas redémarrer. Si la chaîne du numéro de modèle est Beacon Plus-BL,ne fonctionne pas.
[aMise hors tension de ConnectionHandler^(BOOL succès, NSErreur *erreur){
    si(succès){
        NSLog(@"Operation success!");
    }
    autre {
        NSLog(@"Opertion failed!");
    }
}];
```

##### Sensor data

BeaconPlus devices integrated a variety of sensors: **HT(Température et humidité )**, **Lumière**, **Accélération** et etc., Actuellement, nous fournissons un APi pour lire les données de l'historique HT/Sixaxis/Magnétomètre/AtmosphericPressure et définir les données des paramètres PIR..

Veuillez vous assurer que l'appareil dispose d'un **capteur HT**, sinon vous ne pourrez pas obtenir les données correctement.

Veuillez vous référer à l'exemple de code ci-dessous.

```c
/*
   aConnectionHandler: une instance de MTConnectionHandler
*/

// lire l'historique HT à partir de l'appareil
[aConnectionHandler.sensorHandler readSensorHistory:^(MTSensorData *données){
  
   // a record corresponds to an instance
   NSInteger time = ((MTSensorHTData *)données).horodatage;   // l'horodatage Unix；
   double température = ((MTSensorHTData *)données).température;    // données de température；
   double hum = ((MTSensorHTData *)données).humidité;       // données d'humidité；
   Indice NSInteger = ((MTSensorHTData *)données).indice;      // nombre de ces données；
  
   si (((MTSensorHTData *)données).endStatus == EndStatusAucun){
       NSLog(@"il n'y a pas de données.");
   }
   sinon si (((MTSensorHTData *)données).endStatus == EndStatusSuccès) {
       NSLog(@"synchronisation des données du capteur avec succès!");
   }
   sinon si (((MTSensorHTData *)données).endStatus == EndStatusError) {
       NSLog(@"quelque chose ne va pas dans la synchronisation des progrès.");   
   }
}];
```

you can vividly display these data with the curve, table ou autre.

Veuillez vous assurer que l'appareil dispose d'un **Capteur PIR**, sinon vous ne pourrez pas obtenir les données correctement.

Veuillez vous référer à l'exemple de code ci-dessous.

```c
/*
   aConnectionHandler: a MTConnectionHandler instance
   aRepeat: un idiot,whether to allow repeated triggers
   aTime:temps de déclenchement, le capteur infrarouge peut être déclenché à nouveau après le temps de déclenchement
*/

// définir le paramètre PIR sur l'appareil
[aConnectionHandler.sensorHandler pirSet:aRépéter etDelayTime:aDélai d'achèvement:^(MTSensorData *données){
   
    si (données.statut) {
        NSLog(@"succès");
    }
    autre {
        NSLog(@"échoué");
    }
}];
```

##### Set triggers

BeaconPlus device has triggers, vous pouvez définir des déclencheurs pour chaque emplacement, l'appareil annoncera l'emplacement correspondant uniquement lorsque la condition de déclenchement est remplie.

Veuillez vous référer à l'exemple de code ci-dessous.

```c
/*
   aConnectionHandler: une instance de MTConnectionHandler
*/

NSInteger sn = 2;                          // Emplacement cible：2
Type de déclencheur = TriggerTypeTempAbove;   // Condition de déclenchement：temperature above
NSInteger value = 10;                      // valeur：10

// créer une instance de déclencheur
// ce déclencheur signifie que lorsque la température > 10 remplir la condition.
MTTriggerData *déclencheur = [[Allocation MTTriggerData]initAvecSlot:type de déclencheur sn:tapez la valeur:valeur];

// écrire sur l'appareil.
[aConnectionHandler writeTrigger:déclencher l'achèvement:^(BOOL succès, NSErreur){
    si(succès){
        NSLog(@"écrire le déclencheur avec succès!");
    }
    autre {
        NSLog(@"échec du déclencheur d'écriture!");
    }
}];

NSInteger slotAtitude = 2;                 // Emplacement cible：2
Type de déclencheur = TriggerTypeTempAbove;   // Condition de déclenchement：temperature above
NSInteger value = 10;                      // température supérieure à：10

// créer une instance de déclencheur
// ce déclencheur signifie que lorsque la température > 10 remplir la condition.
MTTriggerData *déclencheur = [[Allocation MTTriggerData] initAvecSlot:paramètre slotAtitudeSupport:vrai type de déclencheur:tapez la valeur:valeur];

// Continue broadcasting after triggering if necessary
trigger.always = true;        // Whether to continue broadcasting after triggering
trigger.advInterval = 100;    // The broadcast interval
trigger.radioTxpower = -20;   // La force du signal de diffusion

// écrire sur l'appareil.
[self.connectedPeripheral.connector writeTrigger:déclencher l'achèvement:^(BOOL succès) {
    si(succès){
        NSLog(@"écrire le déclencheur avec succès!");
    }
    autre {
        NSLog(@"échec du déclencheur d'écriture!");
    }
}];

```

Set and query whether the vibration is turned on, la trame de diffusion du capteur de vibration sera reçue lorsque la vibration est activée, et la trame de diffusion du capteur de vibration ne sera pas diffusée lorsque la vibration est désactivée.

```c
   
 //    MTVibrationTypeOpen,
//    MTVibrationTypeFermer,
//    MTVibrationTypeError,
  [self.currentPeripheral.connector.sensorHandler setVibrationStatus:MTVibrationTypeOpen CompletionHandler:^(BOOL est un succès) {

}];

[self.currentPeripheral.connector.sensorHandler queryVibrationStatu:^(BOOL est un succès, Type MTVibrationType) {

}];
```

Set and query the sensitivity of the vibration sensor.

```c
    //    MTSensitivityTypeSuperHigh,
    //    MTSensitivityTypeHigh,
    //    MTSensitivityTypeMiddle,
    //    MTSensitivityTypeFaible,
    //    MTSensitivityTypeSuperLow,
    [self.currentPeripheral.connector.sensorHandler setSensitivity:MTSensitivityTypeHigh CompletionHandler:^(BOOL est un succès) {
        
    }];

[self.currentPeripheral.connector.sensorHandler querySensitivity:^(BOOL est un succès, Type MTSensitivityType) {
        
    }];
```

Set and query the vibration sensor warning time interval. L'heure de début doit être inférieure à l'heure de fin, précis à l'heure et à la minute près. En outre, les paramètres doivent être calculés. Par exemple, depuis 6:10 le matin pour 10:00 dans la soirée, heure de début = 6 \* 3600 + 10 \* 60 = 22200, heure de fin = 22 \* 3600 + 0 \* 60 = 79200.

```c
    // fuseau horaire = heures*3600 + minutes*60
    // 22200 = 6*3600 + 10*60 = 6:30
    [self.currentPeripheral.connector.sensorHandler setFirstAlarmTimeIntervalWithAlarmStatus:MTVibrationTypeOpen StartTime:22200 Heure de fin:79200 Gestionnaire d'achèvement:^(BOOL est un succès) {
        
    }];
    
    [self.currentPeripheral.connector.sensorHandler queryFirstAlarmTimeInterval:^(BOOL est un succès, Type MTVibrationType, uint32_t heure de démarrage, uint32_t heure de fin) {
        NSLog(@"Type de vibration:%@, Heure de début:%dheure %dminute, heure de fin:%dheure %dminute", type == MTVibrationTypeOuvert ? @"Ouvrir" : @"Fermer ou Erreur", heure de début/3600, heure de début600/60, heure de fin/3600, heure de fin600/60);
    }];
    
    [self.currentPeripheral.connector.sensorHandler setSecondAlarmTimeIntervalWithAlarmStatus:MTVibrationTypeOpen StartTime:22200 Heure de fin:79200 Gestionnaire d'achèvement:^(BOOL est un succès) {
        
    }];
    
    [self.currentPeripheral.connector.sensorHandler querySecondAlarmTimeInterval:^(BOOL est un succès, Type MTVibrationType, uint32_t heure de démarrage, uint32_t heure de fin) {
        
    }];
    
    [self.currentPeripheral.connector.sensorHandler setThirdAlarmTimeIntervalWithAlarmStatus:MTVibrationTypeOpen StartTime:22200 Heure de fin:79200 Gestionnaire d'achèvement:^(BOOL est un succès) {
        
    }];
    
    [self.currentPeripheral.connector.sensorHandler queryThirdAlarmTimeInterval:^(BOOL est un succès, Type MTVibrationType, uint32_t heure de démarrage, uint32_t heure de fin) {
        
    }];
```

### Set broadcast rate

When the model is MBM01 and the firmware version is 2.5.x, vous pouvez définir le Bluetooth 4.0 1Débit de diffusion Mbps ou Bluetooth 5.0 125Débit de diffusion Kbps pour le canal de trame.

Chacun des six canaux de diffusion occupe une valeur. Lorsque la valeur est définie sur 0, il représente le Bluetooth 4.2 1Mode de diffusion Mbps, et lorsque la valeur est définie sur 1, il représente le Bluetooth 5.0 125Mode de diffusion Kbps.

\*\*A noter qu'iOS ne peut actuellement pas obtenir le bouquet radio avec une fréquence radio de 125Kbps, et Android n'a pas ce problème. C'est, le canal de trame du Bluetooth 5.0 le débit de diffusion est réglé à 125 Kbps sur iOS. Une fois le réglage terminé, le cadre ne peut pas être numérisé sur l'iPhone, mais le cadre peut être scanné sur Android. \*\*

```c
    [self.currentPeripheral.connector.sensorHandler queryBroadcastSpeed:^(BOOL est un succès, NSArray * _Nonnull BroadcastSpeedOfSlotArray) {
        NSLog(@"Le taux de diffusion de la première chaîne est %@", [diffusionSpeedOfSlotArray[0] valeurint] == 1 ? @"Bluetooth5.0 125Kbps" : @"Bluetooth4.0 1Mbps");
    }];
    
    // Lors du réglage du débit de diffusion, le tableau entrant a six valeurs, et chaque valeur correspond à six canaux. 0 signifie que le taux de diffusion de Bluetooth 4.0 est de 1 Mbps, et 1 signifie que le taux de diffusion de Bluetooth 5.0 est de 125 Kbit/s. Par exemple, si les premier et deuxième canaux sont réglés sur une diffusion à 125 Kbps, et les autres chaînes sont réglées sur une diffusion à 1 Mbps, alors les paramètres sont les suivants:
    [self.currentPeripheral.connector.sensorHandler setBroadcastSpeed:@[@1,@1,@0,@0,@0,@0] Gestionnaire d'achèvement:^(BOOL est un succès) {
        
    }];
```

### Set the parameter configuration items of the configurable firmware of the Acc sensor

This function belongs to the exclusive supporting function of customized firmware, veuillez consulter le personnel commercial concerné avant de l'utiliser.

Le capteur Acc peut être configuré avec des éléments de configuration du micrologiciel et des paramètres qui peuvent être définis.

ODR ( Taux de sortie ) :

| description | valeur |
| --- | --- |
| 1Hz | 0 |
| 10Hz | 1 |
| 25Hz | 2 |
| 50Hz | 3 |
| 100Hz | 4 |
| 200Hz | 5 |
| 400Hz | 6 |
| 1600Hz (faible puissance) | 7 |
| 1344Hz (FC/normale) /5000Hz(batterie faible) | 8 |

réveil_seuil ( mg ) : 0 ~ 2000

réveil_durée ( MS ) : 0 ~ 127000

```c  [self.currentPeripheral.connector.sensorHandler queryAccSensorParameterWithCompletionHandler:^(BOOL est un succès, NSInteger odr, NSInteger wakeupThreshold, NSInteger wakeupDuration) {  
      
    }];

[self.currentPeripheral.connector.sensorHandler setAccSensorParameterWithOdr:0 Seuil de réveil:200 Durée de réveil:1000 Gestionnaire d'achèvement:^(BOOL est un succès) {   
      
    }];
```

At the end of this part, vous pouvez consulter tout le code ci-dessus pour développer. Bien sûr, nous avons pris note de chaque API du SDK., s'il y a quelque chose de nouveau, nous mettrons à jour ce document.

## Remarques

1.  En cours de développement, vous constaterez peut-être qu'il existe **plusieurs instances MTPeripheral** correspondant à un périphérique physique. Sur ce point, nous avons consulté les ingénieurs d'Apple. ils nous ont dit qu'actuellement sur la plateforme iOS, Le framework CoreBluetooth n'est pas compatible avec les périphériques à plusieurs emplacements(en particulier les données publicitaires en évolution). à cause de cela, parfois l'application ne peut pas se connecter à l'appareil, Google Eddystone résout ce problème en **appuyant sur le bouton sur les appareils Eddystone**, notre appareil prend également en charge cette opération.
    
    iOS11 n'a pas ce problème.
    
2.  En phase de numérisation, certaines propriétés peuvent être nulles, surtout l'adresse MAC(restriction d'iOS),si l'appareil actuel annonce le cadre **DeviceInfo**, alors tu peux obtenir le nom, Adresse MAC et batterie.
    
3.  Après 5 moins l'application connectée à l'appareil, l'appareil prendra l'initiative de se déconnecter.
    
4.  Si l'écran en cours d'exécution ne trouve pas le chemin après l'ajout du SDK, remove the package and add it again at General-> Frameworks,Bibliothèques,et contenu intégré

## Other

BeaconPlus SDK is also used in our BeaconSET+ app. Si vous avez besoin d'une compréhension plus intuitive de nos équipements beaconPlus et des fonctions correspondantes du SDK, vous pouvez également télécharger l'application BeaconSET+ pour en savoir plus. (Rappel: L'application BeaconSET+ et le SDK BeaconPlus doivent être utilisés avec des équipements produits par notre société.)

## Journal des modifications

-   2017.10.11 v1.0 première version;
-   2019.01.07 v1.1 deuxième version;
-   2019.07.11 v1.2 changer la mise hors tension;
-   2020.03.27 v1.10.0 ajouter LineBeacon;
-   2020.07.27 v1.10.1 Optimiser l'obtention et le paramétrage du cadre LineBeacon
-   2020.10.27 v1.10.2 Ajout de la propriété lastUpdate pour chaque trame de diffusion
-   2021.4.21 v1.11.0 Ajout d'un capteur Sixaxis/Magnétomètre/AtmosphericPressure
-   2021.4.28 v1.11.1 Ajout d'un capteur de vibrations
-   2021.09.16 v1.13.0 Ajout d'un capteur pir
-   2021.10.9 v1.14.0 Bluetooth nouvellement configuré 5.0 taux de diffusion
-   2021.12.27 v1.14.1 Ajout de nouveaux éléments de configuration de paramètres pour le micrologiciel configurable du capteur d'accélération adaptable
-   2022.5.10 Prise en charge de la modification des paramètres de la trame ACC
-   2022.6.1 v1.16.0 Ajout de la trame de diffusion IN100 MinewMBeaconInfo
-   2023.11.13 v1.17.0 Correction d'un crash de WriteFrame; prise en charge de l'analyse en arrière-plan