{"id":825,"date":"2010-12-05T06:51:10","date_gmt":"2010-12-05T13:51:10","guid":{"rendered":"http:\/\/www.serialporttool.com\/sptblog\/?p=825"},"modified":"2010-12-05T06:51:10","modified_gmt":"2010-12-05T13:51:10","slug":"how-to-run-at-command-in-api-mode","status":"publish","type":"post","link":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/","title":{"rendered":"How to Run AT command in API mode"},"content":{"rendered":"

In ZigBee Operator<\/a>, it is very easy to run AT command in API mode.<\/p>\n

Here are the examples for run get firmware AT command \u201cVR\u201d.<\/p>\n

In XBee\/XBee-Pro ZB profile.<\/p>\n

Steps:<\/p>\n

Switch to XBee\/XBee Pro ZB Profile.<\/p>\n

Input ASCII characters \u201cVR\u201d in command field and click button \u201cSend\u201d will send the command.<\/p><\/blockquote>\n

Here is screenshot of the quick send panel.<\/p>\n

\"image\"<\/a><\/p>\n

Here is the message in log window.<\/p>\n

Send:(21:25:54) 7E 00 04 08 01 56 52 4E <\/span><\/p>\n

Data Parsed: 7E 00 04 08 01 56 52 4E
\nAT Command
\nFrame ID: 0x01
\nCommand: VR
\nPara(Hex):
\nPara(Text):<\/span><\/p>\n

Rec:(21:25:54)7E 00 07 88 01 56 52 00 21 70 3D
\nData Parsed: 7E 00 07 88 01 56 52 00 21 70 3D
\nAT Command Response
\nFrame ID: 1
\nCommand: VR
\nStatus: 0 = OK
\nPara: 21 70 <\/span><\/p><\/blockquote>\n

ZigBee Operator<\/a> will send a data frame to module. It starts with \u201c7E\u201d and \u201c08\u201d is the flag for AT command. The \u201c0x56 0x52\u201d are ASCII code for character \u201cVR\u201d. The command are not case sensitive. Both \u201cVR\u201d and \u201cvr\u201d works.<\/p>\n

The module will send a \u201cAT Command Response\u201d data frame to ZigBee Operator. The last line \u201cPara\u201d is the command result. In this sample, it is \u201c21 70\u201d, means the firmware is 2170, the firmware for API Zigbee coordinator.<\/p>\n

To run a command with a parameters, like \u201cSN\u201dcommand, which\u00a0 sets the number of sleep periods to not assert the On\/Sleep pin on wakeup if no RF data is waiting for the end device. The default value for this command is 1. Send \u201cSN\u201d command without any parameter like example above will return the value.<\/p>\n

Here are the message in Log window.<\/p>\n

Send:(21:39:51) 7E 00 04 08 01 53 4E 55<\/p>\n

Data Parsed: 7E 00 04 08 01 53 4E 55
\nAT Command
\nFrame ID: 0x01
\nCommand: SN
\nPara(Hex):
\nPara(Text):<\/span><\/p>\n

Rec:(21:39:51)7E 00 07 88 01 53 4E 00 00 01 D4
\nData Parsed: 7E 00 07 88 01 53 4E 00 00 01 D4
\nAT Command Response
\nFrame ID: 1
\nCommand: SN
\nStatus: 0 = OK
\nPara: 00 01\u00a0 <\/span><\/p><\/blockquote>\n

The value of SN is 1.<\/p>\n

To set a value for SN, input the value in Parameters field. The value are in hex. Input \u201c20\u201d in parameters will set the value to 20.<\/p>\n

\"image\"<\/a><\/p>\n

Here are the message in Log window.<\/p>\n

Send:(21:46:06) 7E 00 05 08 01 53 4E 20 35 <\/span><\/p>\n

Data Parsed: 7E 00 05 08 01 53 4E 20 35
\nAT Command
\nFrame ID: 0x01
\nCommand: SN
\nPara(Hex):20
\nPara(Text): <\/span><\/p>\n

Rec:(21:46:06)7E 00 05 88 01 53 4E 00 D5
\nData Parsed: 7E 00 05 88 01 53 4E 00 D5
\nAT Command Response
\nFrame ID: 1
\nCommand: SN
\nStatus: 0 = OK
\nPara:
\n<\/span><\/p><\/blockquote>\n

It showed that command are run success.<\/p>\n

Run \u201cSN\u201d command and leave parameters field blank will query the value of SN again.<\/p>\n

Here are the message in Log window.<\/p>\n

Send:(21:48:34) 7E 00 04 08 01 53 4E 55 <\/span><\/p>\n

Data Parsed: 7E 00 04 08 01 53 4E 55
\nAT Command
\nFrame ID: 0x01
\nCommand: SN
\nPara(Hex):
\nPara(Text):<\/span><\/p>\n

Rec:(21:48:34)7E 00 07 88 01 53 4E 00 00 20 B5
\nData Parsed: 7E 00 07 88 01 53 4E 00 00 20 B5
\nAT Command Response
\nFrame ID: 1
\nCommand: SN
\nStatus: 0 = OK
\nPara: 00 20\u00a0 <\/span><\/p><\/blockquote>\n

The value of SN is 20 now.<\/p>\n

It is same for 802.15.4 devices, just switch to 802.15.4 profile and send command there.<\/p>\n

\"image\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

In ZigBee Operator, it is very easy to run AT command in API mode. Here are the examples for run get firmware AT command \u201cVR\u201d. In XBee\/XBee-Pro ZB profile. Steps: Switch to XBee\/XBee Pro ZB Profile. Input ASCII characters \u201cVR\u201d […]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[57,58,55,45],"class_list":["post-825","post","type-post","status-publish","format-standard","hentry","category-zigbee","tag-api-mode","tag-at-command","tag-zigbee-2","tag-zigbee-operator"],"yoast_head":"\nHow to Run AT command in API mode - Serial Port Tool<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to Run AT command in API mode - Serial Port Tool\" \/>\n<meta property=\"og:description\" content=\"In ZigBee Operator, it is very easy to run AT command in API mode. Here are the examples for run get firmware AT command \u201cVR\u201d. In XBee\/XBee-Pro ZB profile. Steps: Switch to XBee\/XBee Pro ZB Profile. Input ASCII characters \u201cVR\u201d […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/\" \/>\n<meta property=\"og:site_name\" content=\"Serial Port Tool\" \/>\n<meta property=\"article:published_time\" content=\"2010-12-05T13:51:10+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png\" \/>\n<meta name=\"author\" content=\"xushirui\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"xushirui\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/\"},\"author\":{\"name\":\"xushirui\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#\/schema\/person\/f588b4f9d1e2e18ebc56957bcdb417cf\"},\"headline\":\"How to Run AT command in API mode\",\"datePublished\":\"2010-12-05T13:51:10+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/\"},\"wordCount\":446,\"publisher\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage\"},\"thumbnailUrl\":\"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png\",\"keywords\":[\"API mode\",\"AT command\",\"ZigBee\",\"ZigBee Operator\"],\"articleSection\":[\"ZigBee & XBee\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/\",\"url\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/\",\"name\":\"How to Run AT command in API mode - Serial Port Tool\",\"isPartOf\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage\"},\"thumbnailUrl\":\"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png\",\"datePublished\":\"2010-12-05T13:51:10+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage\",\"url\":\"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png\",\"contentUrl\":\"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.serialporttool.com\/GK\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to Run AT command in API mode\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#website\",\"url\":\"https:\/\/www.serialporttool.com\/GK\/\",\"name\":\"Serial Port Tool\",\"description\":\"Software Solution for Serial Port and Network Control\",\"publisher\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.serialporttool.com\/GK\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#organization\",\"name\":\"Ginkgo LLC\",\"url\":\"https:\/\/www.serialporttool.com\/GK\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.serialporttool.com\/GK\/wp-content\/uploads\/2019\/07\/SerialPortToolSmallOutline.png\",\"contentUrl\":\"https:\/\/www.serialporttool.com\/GK\/wp-content\/uploads\/2019\/07\/SerialPortToolSmallOutline.png\",\"width\":565,\"height\":128,\"caption\":\"Ginkgo LLC\"},\"image\":{\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#\/schema\/logo\/image\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#\/schema\/person\/f588b4f9d1e2e18ebc56957bcdb417cf\",\"name\":\"xushirui\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.serialporttool.com\/GK\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/d4eaaf6aba2e36365bc8d8ca8dca05e05082a6df3df53c180d609d133fa2ae3f?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/d4eaaf6aba2e36365bc8d8ca8dca05e05082a6df3df53c180d609d133fa2ae3f?s=96&d=mm&r=g\",\"caption\":\"xushirui\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to Run AT command in API mode - Serial Port Tool","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/","og_locale":"en_US","og_type":"article","og_title":"How to Run AT command in API mode - Serial Port Tool","og_description":"In ZigBee Operator, it is very easy to run AT command in API mode. Here are the examples for run get firmware AT command \u201cVR\u201d. In XBee\/XBee-Pro ZB profile. Steps: Switch to XBee\/XBee Pro ZB Profile. Input ASCII characters \u201cVR\u201d […]","og_url":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/","og_site_name":"Serial Port Tool","article_published_time":"2010-12-05T13:51:10+00:00","og_image":[{"url":"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png","type":"","width":"","height":""}],"author":"xushirui","twitter_card":"summary_large_image","twitter_misc":{"Written by":"xushirui","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#article","isPartOf":{"@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/"},"author":{"name":"xushirui","@id":"https:\/\/www.serialporttool.com\/GK\/#\/schema\/person\/f588b4f9d1e2e18ebc56957bcdb417cf"},"headline":"How to Run AT command in API mode","datePublished":"2010-12-05T13:51:10+00:00","mainEntityOfPage":{"@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/"},"wordCount":446,"publisher":{"@id":"https:\/\/www.serialporttool.com\/GK\/#organization"},"image":{"@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage"},"thumbnailUrl":"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png","keywords":["API mode","AT command","ZigBee","ZigBee Operator"],"articleSection":["ZigBee & XBee"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/","url":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/","name":"How to Run AT command in API mode - Serial Port Tool","isPartOf":{"@id":"https:\/\/www.serialporttool.com\/GK\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage"},"image":{"@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage"},"thumbnailUrl":"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png","datePublished":"2010-12-05T13:51:10+00:00","breadcrumb":{"@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#primaryimage","url":"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png","contentUrl":"http:\/\/www.serialporttool.com\/sptblog\/wp-content\/uploads\/2010\/12\/image_thumb.png"},{"@type":"BreadcrumbList","@id":"https:\/\/www.serialporttool.com\/GK\/2010\/12\/how-to-run-at-command-in-api-mode\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.serialporttool.com\/GK\/"},{"@type":"ListItem","position":2,"name":"How to Run AT command in API mode"}]},{"@type":"WebSite","@id":"https:\/\/www.serialporttool.com\/GK\/#website","url":"https:\/\/www.serialporttool.com\/GK\/","name":"Serial Port Tool","description":"Software Solution for Serial Port and Network Control","publisher":{"@id":"https:\/\/www.serialporttool.com\/GK\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.serialporttool.com\/GK\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.serialporttool.com\/GK\/#organization","name":"Ginkgo LLC","url":"https:\/\/www.serialporttool.com\/GK\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.serialporttool.com\/GK\/#\/schema\/logo\/image\/","url":"https:\/\/www.serialporttool.com\/GK\/wp-content\/uploads\/2019\/07\/SerialPortToolSmallOutline.png","contentUrl":"https:\/\/www.serialporttool.com\/GK\/wp-content\/uploads\/2019\/07\/SerialPortToolSmallOutline.png","width":565,"height":128,"caption":"Ginkgo LLC"},"image":{"@id":"https:\/\/www.serialporttool.com\/GK\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/www.serialporttool.com\/GK\/#\/schema\/person\/f588b4f9d1e2e18ebc56957bcdb417cf","name":"xushirui","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.serialporttool.com\/GK\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/d4eaaf6aba2e36365bc8d8ca8dca05e05082a6df3df53c180d609d133fa2ae3f?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d4eaaf6aba2e36365bc8d8ca8dca05e05082a6df3df53c180d609d133fa2ae3f?s=96&d=mm&r=g","caption":"xushirui"}}]}},"_links":{"self":[{"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/posts\/825","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/comments?post=825"}],"version-history":[{"count":0,"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/posts\/825\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/media?parent=825"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/categories?post=825"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.serialporttool.com\/GK\/wp-json\/wp\/v2\/tags?post=825"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}