وصال

این ماژول شامل توابعی برای نقش Thread Joiner است.

خلاصه

شمارش ها

otJoinerState شمارش
این شمارش وضعیت Joiner را تعریف می کند.

Typedefs

otJoinerCallback )(otError aError, void *aContext) typedef
void(*
این نشانگر تابع برای اطلاع از اتمام عملیات اتصال فراخوانی می شود.
otJoinerDiscerner typedef
این ساختار نشان دهنده Joiner Discerner است.
otJoinerState typedef
این شمارش وضعیت Joiner را تعریف می کند.

کارکرد

otJoinerGetDiscerner ( otInstance *aInstance)
این تابع Joiner Discerner را دریافت می کند.
otJoinerGetId ( otInstance *aInstance)
const otExtAddress *
این تابع شناسه Joiner را دریافت می کند.
otJoinerGetState ( otInstance *aInstance)
این تابع وضعیت Joiner را برمی گرداند.
otJoinerSetDiscerner ( otInstance *aInstance, otJoinerDiscerner *aDiscerner)
این تابع Joiner Discerner را تنظیم می کند.
otJoinerStart ( otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
این تابع نقش Thread Joiner را فعال می کند.
otJoinerStateToString ( otJoinerState aState)
const char *
این تابع یک مقدار شمارش حالت اتصال دهنده را به یک رشته قابل خواندن توسط انسان تبدیل می کند.
otJoinerStop ( otInstance *aInstance)
void
این تابع نقش Thread Joiner را غیرفعال می کند.

سازه ها

otJoinerDiscerner

این ساختار نشان دهنده Joiner Discerner است.

شمارش ها

otJoinerState

 otJoinerState

این شمارش وضعیت Joiner را تعریف می کند.

Typedefs

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

این نشانگر تابع برای اطلاع از اتمام عملیات اتصال فراخوانی می شود.

جزئیات
مولفه های
[in] aError
در صورت موفقیت فرآیند پیوستن، OT_ERROR_NONE. OT_ERROR_SECURITY اگر فرآیند پیوستن به دلیل اعتبارنامه امنیتی ناموفق بود. OT_ERROR_NOT_FOUND اگر هیچ شبکه قابل اتصالی کشف نشد. اگر زمان پاسخ تمام شد OT_ERROR_RESPONSE_TIMEOUT.
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

این ساختار نشان دهنده Joiner Discerner است.

otJoinerState

enum otJoinerState otJoinerState

این شمارش وضعیت Joiner را تعریف می کند.

کارکرد

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

این تابع Joiner Discerner را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به نمونه OpenThread.
برمی گرداند
یک اشاره گر به Joiner Discerner یا NULL اگر هیچ یک تنظیم نشده باشد.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

این تابع شناسه Joiner را دریافت می کند.

اگر Joiner Discerner تنظیم نشده باشد، Joiner ID 64 بیت اول از نتیجه محاسبه SHA-256 بر روی IEEE EUI-64 اختصاص داده شده توسط کارخانه است. در غیر این صورت شناسه Joiner از مقدار Joiner Discerner محاسبه می شود.

شناسه Joiner همچنین به عنوان آدرس IEEE 802.15.4 Extended Address در طول فرآیند راه اندازی استفاده می شود.

جزئیات
مولفه های
[in] aInstance
اشاره گر به نمونه OpenThread.
برمی گرداند
اشاره گر به شناسه Joiner.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

این تابع وضعیت Joiner را برمی گرداند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

این تابع Joiner Discerner را تنظیم می کند.

Joiner Discerner برای محاسبه Joiner ID مورد استفاده در فرآیند راه اندازی/پیوستن استفاده می شود.

به‌طور پیش‌فرض (زمانی که تشخیص‌دهنده ارائه نشده یا روی NULL تنظیم شده باشد)، شناسه Joiner به‌عنوان 64 بیت اول از نتیجه محاسبه SHA-256 بر روی IEEE EUI-64 اختصاص داده شده توسط کارخانه به‌دست می‌آید. توجه داشته باشید که این رفتار اصلی مورد انتظار مشخصات Thread است.

جزئیات
مولفه های
[in] aInstance
اشاره گر به نمونه OpenThread.
[in] aDiscerner
اشاره‌ای به Joiner Discerner. اگر NULL هر تشخیص دهنده ای که قبلا تنظیم شده را پاک می کند.
ارزش های بازگشتی
OT_ERROR_NONE
Joiner Discerner با موفقیت به روز شد.
OT_ERROR_INVALID_ARGS
aDiscerner معتبر نیست (طول مشخص شده در محدوده معتبر نیست).
OT_ERROR_INVALID_STATE
یک فرآیند پیوستن در حال انجام است، بنابراین Joiner Discerner قابل تغییر نیست.

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

این تابع نقش Thread Joiner را فعال می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPskd
اشاره گر به PSKd.
[in] aProvisioningUrl
اشاره گر به URL تامین (ممکن است NULL باشد).
[in] aVendorName
اشاره گر به نام فروشنده (ممکن است NULL باشد).
[in] aVendorModel
اشاره گر به مدل فروشنده (ممکن است NULL باشد).
[in] aVendorSwVersion
اشاره گر به نسخه SW Vendor (ممکن است NULL باشد).
[in] aVendorData
یک اشاره گر به داده های فروشنده (ممکن است NULL باشد).
[in] aCallback
اشاره گر به تابعی که پس از اتمام عملیات اتصال فراخوانی می شود.
[in] aContext
اشاره‌ای به زمینه خاص برنامه.
ارزش های بازگشتی
OT_ERROR_NONE
نقش Joiner را با موفقیت شروع کرد.
OT_ERROR_BUSY
تلاش قبلی هنوز ادامه دارد.
OT_ERROR_INVALID_ARGS
aPskd یا aProvisioningUrl نامعتبر است.
OT_ERROR_INVALID_STATE
پشته IPv6 فعال نیست یا پشته Thread کاملاً فعال است.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

این تابع یک مقدار شمارش حالت اتصال دهنده را به یک رشته قابل خواندن توسط انسان تبدیل می کند.

جزئیات
مولفه های
[in] aState
حالت وصال.
برمی گرداند
یک نمایش رشته ای قابل خواندن توسط انسان از aState .

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

این تابع نقش Thread Joiner را غیرفعال می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.

ماکروها

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

حداکثر طول یک Joiner Discerner بر حسب بیت.

منابع

موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.