معصمه SDK - WristbandKit

معصمه SDK

##  MTWristbandKit Documentation
 
This set of SDK only supports Bluetooth Wristband devices produced by Minew. يمكن لـ SDK مساعدة المطورين في التعامل مع جميع الأعمال بين الهاتف وسوار المعصم, مشتمل: مسح الجهاز, توصيل الجهاز, كتابة البيانات على الجهاز, استقبال البيانات من الجهاز, إلخ.

## Preliminary work

Overall framework: MTWristbandCentralManager هي فئة إدارة الأجهزة, وهو دائمًا مفرد عند تشغيل التطبيق. MTWristbandPeripheral هي فئة مثيل الجهاز. سيقوم هذا الجناح بإنشاء مثيل MTWristbandPeripheral لكل جهاز لتسهيل مراقبة الأجهزة وتشغيلها.

**MTWristbandCentralManager** : فئة إدارة الأجهزة, والتي يمكنها فحص أجهزة معصمه المحيطة, ويمكن ربطها, التحقق منها, إلخ.

**MTWristbandPeripheral ** : فئة مثيل الجهاز. عندما يكتشف MTWristbandCentralManager جهازًا فعليًا, سيقوم MTWristbandCentralManager بإنشاء مثيل MTWristbandPeripheral, الذي يتوافق مع جهاز مادي.

**MTWristbandBroadcast** : فئة بث الجهاز, والتي يمكنها الحصول على البيانات عند بث الجهاز.

**MTWristbandConnection** : فئة اتصال الجهاز لاستقبال وإرسال البيانات من الجهاز.

**متكوماند** : التحقق من المعدات ومعالجة البيانات.

## ابدأ

### بيئة التطوير:

\-Xcode12 +, يتم تجميع SDK الحالي باستخدام Xcode12, يرجى استخدام Xcode12 وما فوق للتطوير; -iOS12, الحد الأدنى لإصدار النظام هو iOS12;

### استيراد إلى المشروع:

1.  كاكاوبودس
    
2.  Manually
    
Copy the development kit files: ملفات MTWristbandKit.a و.h إلى دليل مشروع المشروع, ومن ثم إضافتها إلى المشروع.

ملاحظة:

1.  !!! في iOS10 وما فوق, أضافت Apple قيودًا على الأذونات على Bluetooth API. تحتاج إلى إضافة سلسلة إلى ملف info.plist الخاص بالمشروع: الخصوصية-وصف استخدام الأجهزة الطرفية للبلوتوث-"وصف الاستخدام الخاص بك".
2.  !!! في iOS13 وما فوق, أضافت Apple قيودًا على الأذونات على Bluetooth API. تحتاج إلى إضافة سلسلة إلى ملف info.plist الخاص بالمشروع: الخصوصية-وصف استخدام البلوتوث دائمًا-"وصف الاستخدام الخاص بك".
3.  إذا تعذر البحث عن MTWristbandKit بواسطة CocoaPods, يوصى بحذف ذاكرة التخزين المؤقت `rm ~/Library/Caches/CocoaPods/search_index.json` والبحث مرة أخرى.

## ابدأ التطوير

### 1.Scanning equipment

First you need to get the singleton of MTWristbandCentralManager, ثم تحقق من حالة Bluetooth الحالية للهاتف, ومن ثم يمكنك فحص الجهاز.

```ج
// Get Manager singleton
MTWristbandCentralManager * مدير = [MTWristbandCentralManager SharedInstance];

إرسال_بعد (إيفاد_تايم (DISPATCH_TIME_NOW, (int64_t) (1 * NSEC_PER_SEC)), send_get_main_queue (), ^ {
    // The current state of the Bluetooth switch on the mobile phone
    if (الذات-> manager.state == PowerStatePoweredOn) {
        // بدء فحص الجهاز
        [مدير startScan: ^ (NSArray <MTWristbandالطرفية *> * الأجهزة) {
        الذات-> DeviceAry = devices;
    }];
    }
});
// يمكن أيضًا الحصول على الأجهزة الممسوحة ضوئيًا باستخدام manager.scannedPeris
// إذا كنت بحاجة إلى الرد على حالة البلوتوث بهاتفك. يرجى الاستماع إلى رد الاتصال.
[قام المدير بتغيير حالة البلوتوث: ^ (حالة الطاقة) {
  يُحوّل (حالة) {
    حالة PowerStatePoweredOn:
        NSLog (@ "تغيير حالة البلوتوث إلى poweron");
        استراحة;
    حالة PowerStatePoweredOff:
        NSLog (@ "تغيير حالة البلوتوث إلى poweroff");
        استراحة;
    حالة PowerStateUnknown:
        NSLog (@ "تغيير حالة البلوتوث إلى غير معروف");
}
}];
```

**PS: يعمل SDK بالكامل فقط عندما تكون حالة Bluetooth الخاصة بالهاتف في Poweron.**

### 2.Wakeup the device

```c
// The scanned device can be obtained from the previous step
MTWristbandPeripheral *device = deviceAry[0];
//استيقظ الجهاز, إنه, يبدأ الهاتف في بث بيانات الاستيقاظ
[مدير بداية الإعلان:Device.broadcast.mac];
//عندما يكون isConnect الخاص بالجهاز هو YES, it means that the device has been woken up
if (Device.broadcast.isConnect) {
    NSLog(@"تم إيقاظ الجهاز");
}
آخر {
    NSLog(@"يحتاج الجهاز إلى التنبيه");
}
//عندما يتم إيقاظ الجهاز, تحتاج إلى إيقاف بث الهاتف المحمول
[مدير توقف الإعلان];
```

### 3.Connect to device

```c
// The scanned device can be obtained from the previous step
MTWristbandPeripheral * جهاز = جهاز آري [0];
// قم بتوصيل الجهاز
[مدير ConnectToPeriperal: جهاز];
// استمع لحالة اتصال الجهاز.
[Device.connector didChangeConnection: ^ (اتصال اتصال) {
    لو (اتصال == التحقق من الصحة) {
      // تم التحقق بنجاح, تم توصيله بالجهاز بنجاح
    }
    لو (اتصال == غير متصل) {
        NSLog (@ "تم قطع اتصال الجهاز.");
    }
}];
```

### 4.Write password to the device

Following the previous step, عندما يقوم الهاتف المحمول بإنشاء اتصال بجهاز معين بنجاح ويتم التحقق بنجاح, يبدأ في كتابة كلمة المرور. بعد نجاح التحقق من كلمة المرور, يمكن إجراء عمليات أخرى.

```ج
[MTCommand كتابة كلمة المرور:لكل كلمة مرور:@"minew123" معالج:^(حالة منطقية) {
    لو (حالة) {
        NSLog(@"كلمة المرور صحيحة");
//ثم افعل ما تريد.
    }
    آخر{
        NSLog(@"كلمة المرور خطأ");
    }
}];
```

### 5.Read historical data records

When the password is successfully written, تم توصيل الجهاز بنجاح, ويمكن إجراء عمليات مثل قراءة سجلات البيانات التاريخية.

1.  Read contact history

```c
[قراءة MTCommandWarningHistory:لكل بداية:0 نهاية:معالج per.broadcast.totalNum-1:^(NSArray * _قيمة غير فارغةAry) {

}];
```

2.  Read temperature history

```c
[قراءة MTCommandTempHistory:لكل بداية:0 نهاية:معالج per.broadcast.tempTotalNum-1:^(NSArray * _قيمة غير فارغةAry) {

}];
```

**Note ⚠️:**

-   Device.broadcast.versionType == 1&&device.broadcast.usage == 2، ثم وظيفة OTA فقط / وظيفة الاغلاق / ما إذا كان سيتم تخزين وظيفة الإعدادات;
-   Device.broadcast.versionType == 1&&device.broadcast.usage == 3، ثم أضف وظيفة استعادة إعدادات المصنع وضبط وظيفة ترس مسافة التنبيه على الوظيفة الأصلية;
-   Device.broadcast.versionType == 2&&device.broadcast.usage == 3، ثم قم بإضافة سجل إنذار درجة الحرارة / وظيفة إعداد الفاصل الزمني لقياس درجة الحرارة / وظيفة ضبط درجة حرارة التنبيه / درجة الحرارة المقاسة الحالية إلى الوظيفة الأصلية.

**يجب عليك الانتباه إلى قراءة سجل إنذار جهة الاتصال بالجهاز وتاريخ إنذار درجة الحرارة. معلمات البداية والنهاية هي الفهرس -1 التي تريد قراءتها. على سبيل المثال, هناك 200 قطع من البيانات. إذا كنت تريد أن تقرأ 9 ل 13 قطع من البيانات, ثم ابدأ = 8, النهاية=12.**

### 6.Set whether to store data

```c
[MTCommand setIsStorageData:لكل مساحة تخزين:معالج التخزين:^(حالة منطقية) {
    لو (حالة) {
        NSLog(@"تم تعيين setIsStorageData بنجاح");
    }
    آخر {
        NSLog(@"فشل setIsStorageData");
    }
}];
```

### 7.ضبط وقراءة معدات المسافة (0-4)

1.  Read

```c
[MTCommand readAlarmDistance:لكل تاجر:^(قيمة كثافة العمليات) {
		لو (قيمة != -1) {
				NSLog(@"قراءة النجاح,المستوى هو %d",قيمة);
		}
		آخر {
				NSLog(@"فشل في القراءة");
		}
}];
```

2.  Set

```c
[MTCommand setAlarmDistance:لكل مستوى:معالج المستوى:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"تم ضبط setAlarmDistance بنجاح");
		} آخر {
				NSLog(@"فشل setAlarmDistance");
		}
}];
```

### 8.ضبط وقراءة درجة حرارة التنبيه (30-42درجه مئوية)

1.  Read

```c
[MTCommand readAlarmTemperature:لكل تاجر:^(قيمة كثافة العمليات) {
		لو (قيمة != -1) {
				NSLog(@"قراءة النجاح,درجة الحرارة %d",قيمة);
		}
		آخر {
				NSLog(@"فشل في القراءة");
		}
}];
```
		
2.  Set

```c
[MTCommand setAlarmTemperature:لكل درجة حرارة:معالج درجة الحرارة:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"تم ضبط درجة الحرارة بنجاح");
		} آخر {
				NSLog(@"فشل ضبط درجة الحرارة");
		}
}];
```

### 9.ضبط وقراءة الفاصل الزمني لقياس درجة الحرارة (0-7200س)

1.  Read

```c
[قراءة MTCommandTemperatureInterval:لكل تاجر:^(قيمة كثافة العمليات) {
		لو (قيمة != -1) {
				NSLog(@"قراءة النجاح,الفاصل الزمني لدرجة الحرارة هو %d",قيمة);
		}
		آخر {
				NSLog(@"فشل في القراءة");
		}
}];
```

2.  Set

```c
[مجموعة MTCommandReadTemperatureInterval:لكل فاصل زمني:معالج الفاصل الزمني:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"تم تعيين ReadTemperatureInterval بنجاح");
		} آخر {
				NSLog(@"فشل تعيين ReadTemperatureInterval");
		}
}];
```

### 10.ضبط وقراءة مفتاح اهتزاز المسافة

1.  Read

```c
[MTCommand readDeviceDistanceVibration:لكل تاجر:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"مفتاح distanceVibration صحيح");
		}
		آخر {
				NSLog(@"مفتاح distanceVibration خاطئ");
		}
}];
```
		
2.  Set
    
```c
[MTCommand setDeviceDistanceVibration:لكل isOn:معالج isOn:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"تم تعيين setDeviceDistanceVibration بنجاح");
		} آخر {
				NSLog(@"فشل setDeviceDistanceVibration");
		}
}];
```

### 11.ضبط وقراءة مفتاح اهتزاز درجة الحرارة

1.  Read
    
```c
[MTCommand readDeviceTempVibration:لكل تاجر:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"مفتاح tempVibration صحيح");
		}
		آخر {
				NSLog(@"مفتاح tempVibration غير صحيح");
		}
}];
```

2.  Set
    
```c
[MTCommand setDeviceTempVibration:لكل isOn:معالج isOn:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"تم تعيين setDeviceTempVibration بنجاح");
		}
		آخر {
				NSLog(@"فشل setDeviceTempVibration");
		}
}];
    ```

### 12.ضبط وقراءة عتبة اهتزاز درجة الحرارة (30-42درجه مئوية)

1.  Read
    
```c
[MTCommand readDeviceTempVibrationThreshold:لكل تاجر:^(قيمة كثافة العمليات) {
		لو (قيمة != -1) {
				NSLog(@"تمت قراءة جهاز readDeviceTempVibrationThreshold بنجاح,عتبة الاهتزاز المؤقتة هي %d",قيمة);
		} آخر {
				NSLog(@"فشل قراءة الجهازTempVibrationThreshold");
		}
}];
```
    
2.  Set
    
```c
[MTCommand setDeviceTempVibrationThreshold:لكل درجة حرارة:معالج درجة الحرارة:^(حالة منطقية) {
		لو (حالة) {
				NSLog(@"تم تعيين setDeviceTempVibrationThreshold بنجاح");
		} آخر {
				NSLog(@"فشل setDeviceTempVibrationThreshold");
		}
}];
```
**The following are advanced operations, يرجى الفهم بوضوح قبل الاتصال بالواجهة.**

### 13.PowerOff

```c
[مجموعة MTCommandPowerOff:لكل تاجر:^(حالة منطقية) {
    لو (حالة) {
        NSLog(@"تم تعيين PowerOff بنجاح");
    }
    آخر {
        NSLog(@"فشل تعيين PowerOff");
    }
}];
```

### 14.Reset

```c
[إعادة تعيين MTCommand:لكل تاجر:^(حالة منطقية) {
    لو (حالة) {
        NSLog(@"إعادة التعيين بنجاح");
    }
    آخر {
        NSLog(@"فشلت إعادة التعيين");
    }
}];
```

### 15.OTA

```c
[MTCommand عبر الإنترنت:لكل ملف Data:معالج البيانات المستهدفة:^(حالة منطقية, تقدم مزدوج) {
    لو (حالة) {
        لو (التقدم == 1) {
            NSLog(@"أوتا بنجاح");
        }
        آخر {
            NSLog(@"التحميل عبر الهواء,تقدم:%F",تقدم);
        }
    }
    آخر {
        NSLog(@"فشل اوتا");
    }
}];
```

**Note⚠️: عند ترقية البرامج الثابتة OTA, يجب عليك إبقاء الهاتف وجهاز المعصم على بعد 50 سم, otherwise it will affect the success of the upgrade**

More details you can see in the demo:https://github.com/minewdevelop/iOS_Minew_WristbandDemo

## جدول

### وصف خاصية MTWristbandCentralManager

| اسم | يكتب | وصف |
| --- | --- | --- |
| ولاية | باور ستيت | حالة بلوتوث الهاتف |
| scannedPeris | NSArray | الأجهزة الممسوحة ضوئيا |

### وصف خاصية MTWristbandPeripheral

| اسم | يكتب | وصف |
| --- | --- | --- |
| معرف | NSString | معرف الجهاز |
| إذاعة | MTWristbandBroadcast | كائن من MTWristbandBroadcast |
| موصل | MTWristbandConnection | كائن من MTWristbandConnection |

### وصف خاصية MTWristbandBroadcast

| اسم | يكتب | وصف |
| --- | --- | --- |
| اسم | NSString | اسم الجهاز |
| آر إس إس آي | NSInteger | جهاز آر إس إس آي |
| ماك | NSString | جهاز ماك |
| معرف | NSString | معرف الجهاز |
| نسخة برنامج ثابت | NSString | com.firmversion |
| com.isConnect | بول | ما إذا كان الجهاز يستيقظ |
| com.isStorage | بول | ما إذا كان الجهاز يخزن البيانات |
| العدد الإجمالي | كثافة العمليات | العدد الإجمالي لسجلات سجل إنذار جهات اتصال الجهاز |
| tempTotalNum | كثافة العمليات | العدد الإجمالي لسجلات سجل إنذار درجة حرارة الجهاز |
| نوع الإصدار | كثافة العمليات | إصدار الأجهزة الجهاز |
| الاستخدام | كثافة العمليات | إصدار متوافق مع البرامج الثابتة للجهاز |

### وصف خاصية MTWristbandConnection

| اسم | يكتب | وصف |
| --- | --- | --- |
| macString | NSString | جهاز ماك |
| اتصال | اتصال | حالة اتصال الجهاز |