कमांड लाइन इंटरफ़ेस

इस मॉड्यूल में ऐसे फ़ंक्शन शामिल हैं जो थ्रेड स्टैक को लागू करने को कंट्रोल करते हैं.

खास जानकारी

टाइपडेफ़

otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) Typedef
int(*
पॉइंटर से कंसोल को आउटपुट के बारे में बताने के लिए कहा जाता है.

फ़ंक्शन

otCliAppendResult(otError aError)
void
सीएलआई कंसोल में गड़बड़ी कोड लिखें.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
सीएलआई मॉड्यूल को शुरू करें.
otCliInputLine(char *aBuf)
void
इसे कंसोल इनपुट लाइन में फ़ीड करने के लिए कहा जाता है.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
सीएलआई कंसोल में हेक्स स्ट्रिंग के तौर पर, कई बाइट डेटा लिखें.
otCliOutputFormat(const char *aFmt, ...)
void
सीएलआई कंसोल में फ़ॉर्मैट की गई स्ट्रिंग लिखें.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
CLI कंसोल में OpenThread लॉग लिखने के लिए कॉलबैक.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
उपयोगकर्ता निर्देश की टेबल सेट करें.
otCliVendorSetUserCommands(void)
void
उपयोगकर्ता को निर्देश देने वाली टेबल में, वेंडर से जुड़े खास निर्देश जोड़ने की अनुमति देने के लिए कॉलबैक.

टाइपडेफ़

otCli आउटपुटCallback

int(* otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments)

पॉइंटर से कंसोल को आउटपुट के बारे में बताने के लिए कहा जाता है.

ब्यौरा
पैरामीटर
[out] aContext
यूज़र कॉन्टेक्स्ट पॉइंटर.
[in] aFormat
फ़ॉर्मैट स्ट्रिंग.
[in] aArguments
फ़ॉर्मैट स्ट्रिंग आर्ग्युमेंट.
लौटाए गए सामान
कॉलबैक की ओर से लिखे गए बाइट की संख्या.

फ़ंक्शन

otCliAppendनतीजा

void otCliAppendResult(
  otError aError
)

सीएलआई कंसोल में गड़बड़ी कोड लिखें.

अगर aError, OT_ERROR_PENDING है, तो कुछ भी आउटपुट नहीं दिया जाएगा.

ब्यौरा
पैरामीटर
[in] aError
गड़बड़ी कोड का मान.

otCliInit

void otCliInit(
  otInstance *aInstance,
  otCliOutputCallback aCallback,
  void *aContext
)

सीएलआई मॉड्यूल को शुरू करें.

ब्यौरा
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का स्ट्रक्चर.
[in] aCallback
एक कॉलबैक मैथड जिसे सीएलआई आउटपुट को प्रोसेस करने के लिए कहा जाता है.
[in] aContext
यूज़र कॉन्टेक्स्ट पॉइंटर.

otCliInputLine

void otCliInputLine(
  char *aBuf
)

इसे कंसोल इनपुट लाइन में फ़ीड करने के लिए कहा जाता है.

ब्यौरा
पैरामीटर
[in] aBuf
ऐसी स्ट्रिंग का संकेत जो शून्य है.

otCli आउटपुटBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

सीएलआई कंसोल में हेक्स स्ट्रिंग के तौर पर, कई बाइट डेटा लिखें.

ब्यौरा
पैरामीटर
[in] aBytes
डेटा के लिए एक पॉइंटर जिसे प्रिंट किया जाना चाहिए.
[in] aLength
लंबाई aBytes.

otCliआउटफ़ॉर्मैट

void otCliOutputFormat(
  const char *aFmt,
  ...
)

सीएलआई कंसोल में फ़ॉर्मैट की गई स्ट्रिंग लिखें.

ब्यौरा
पैरामीटर
[in] aFmt
फ़ॉर्मैट स्ट्रिंग का पॉइंटर.
[in] ...
आर्ग्युमेंट से मिलती-जुलती सूची.

otCliPlatLogv

void otCliPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

CLI कंसोल में OpenThread लॉग लिखने के लिए कॉलबैक.

ब्यौरा
पैरामीटर
[in] aLogLevel
लॉग लेवल.
[in] aLogRegion
लॉग क्षेत्र.
[in] aFormat
फ़ॉर्मैट स्ट्रिंग का पॉइंटर.
[in] aArgs
va_list एक मिलान करता है.

otCliSetUserCommands

otError otCliSetUserCommands(
  const otCliCommand *aUserCommands,
  uint8_t aLength,
  void *aContext
)

उपयोगकर्ता निर्देश की टेबल सेट करें.

ब्यौरा
पैरामीटर
[in] aUserCommands
उपयोगकर्ता के निर्देशों वाली श्रेणी का पॉइंटर.
[in] aLength
लंबाई aUserCommands.
[in] aContext
The कॉन्टेक्स्ट को पास किया गया.
लौटाने की वैल्यू
OT_ERROR_NONE
aUserCommands से मिले निर्देश की मदद से, टेबल की टेबल अपडेट की गई.
OT_ERROR_FAILED
पहले से ही ज़्यादा से ज़्यादा कमांड एंट्री सेट की जा चुकी हैं.

otCliविक्रेताSetUserCommands

void otCliVendorSetUserCommands(
  void
)

उपयोगकर्ता को निर्देश देने वाली टेबल में, वेंडर से जुड़े खास निर्देश जोड़ने की अनुमति देने के लिए कॉलबैक.

तब उपलब्ध होता है, जब OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE चालू हो और OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES 1 से ज़्यादा हो.

रिसॉर्स

OpenThread एपीआई के संदर्भ विषय, सोर्स कोड से आते हैं और GitHub पर उपलब्ध होते हैं. ज़्यादा जानकारी पाने या हमारे दस्तावेज़ में योगदान देने के लिए, संसाधन देखें.