anki_vector SDK源碼解析(教程)

一：最近anki vector robot開放了Python SDK，我聽到的第一時間就趕快上網查了查，先拋幾個官網重要鏈接吧：

Python編程API手冊及環境搭建等：

　　 https://sdk-resources.anki.com/vector/docs/generated/anki_vector.html

anki公司github地址及anki_vectorSDK實現源碼，用於理解電腦和vector的通信協議，包含教學例程：

　　 https://github.com/anki/vector-python-sdk

一些關於cozmo和vector編程使用的Web工具，可以在瀏覽器看到機器人看到的圖像：

　　 https://github.com/GrinningHermit/Vector-Explorer-Tool

anki編程交流社區：

　　 https://forums.anki.com/

cozmo在線手冊：

　　 http://cozmosdk.anki.com/docs/initial.html

cozmo編程SDK源碼及教學例程源碼：

　　 https://github.com/anki/cozmo-python-sdk

new:DDL官方SDK教學視頻：(40分鍾)(2020年新出的)

　　 https://courses.digitaldreamlabs.com/enrollments

目前沒有相關書籍，anki不是像google一樣的一流大廠。筆者從事C++開發，對python編程也是小白級別，對vector編程的學習也全是靠上面這幾個鏈接。

 

　　首先，你得擁有一台vector和一台能用於編程的電腦（對操作系統沒有要求，這點很不錯），使它們處於同一個局域網內（都連着家里的wifi就行）。具體安裝python和搭建環境等細節不再展開，在線文檔寫的已經很詳盡了。

 轉載請注明出處：https://www.cnblogs.com/xjjsk/p/10159946.html

二：接下來的部分介紹幾個簡單的官網demo：

　　源碼目錄：vector-python-sdk-master/examples/tutorials/

#01_hello_world.py

import anki_vector

def main():
　　args = anki_vector.util.parse_command_args()
　　with anki_vector.Robot(args.serial) as robot:
　　　　print("Say 'Hello World'...")
　　　　robot.say_text("Hello World")

if __name__ == "__main__":
　　main()

首先，第3行引入anki_vector模塊，其實就是一個叫做anki_vector的文件夾，目前所有的程序，只需要引入這個模塊就擁有vector的所有控制功能了。

 第6行解析命令行參數，只需要寫在這就行了，暫時用不着命令行參數。

第7行將解析后的命令行參數傳給Robot類，創建一個Robot對象，取名為robot。

從第8行開始操作robot，就能完成所有對vector機器人的操作了。

例如，第9行讓你的機器人說一句“Hello World”，目前不支持中文，但是可以用漢語拼音哈哈哈。

11行和12行，如果這個文件是被別的文件引用，則main只是個普通被調函數，否則就執行main()函數。

其實，每一個程序都是這么寫的，你只需要復制上面的代碼，將第8、9兩行換成你需要實現的邏輯就行，而所有的控制，都可以通過robot對象實現。

當然，引入anki_vector模塊就是為了得到robot對象的，除了這個模塊，你還可以引入任何其他python庫進來玩，甚至可以使用ros、opencv等龐大的庫進行人工智能編程。

如果不清楚robot里面支持哪些操作，可以翻閱其他的例程和 vector的在線API文檔。如果有遇到非常奇怪的Bug，可以到vector社區提出，與其他開發者交流。

 

　　其實我感覺anki_vector的接口封裝的特別好，就只需要看上面一個例子，再結合API文檔，就能玩遍所有功能了。

 

anki_vector.Robot(args.serial)，這一句是創建一個robot對象，並連接到你的小V，每個程序開頭一般都少不了這一行。而Robot這個對象的創建也是具有很多參數的，在這個例子中它只帶了一個參數，其他的參數都使用默認參數。下面列出了這個重要的構造函數的所有參數及默認值：

class Robot:
　　def __init__(self,
　　　　serial: str = None,#矢量序號。機器人的序號(ex. 00e20100)位於向量的底面，或從Vector的調試屏幕訪問。用於確定要加載哪個向量配置。
　　　　ip: str = None,#Vector的ip地址。(可選)
　　　　config: dict = None,#自定義的dict，覆蓋Vector配置中的值。(可選)
　　　　default_logging: bool = True,#記錄日志
　　　　behavior_activation_timeout: int = 10,#連接超時時間。
　　　　cache_animation_list: bool = True,#獲取啟動時可用的動畫列表。
　　　　enable_face_detection: bool = False,#相冊開關。
　　　　enable_camera_feed: bool = False,#相機開關
　　　　enable_audio_feed: bool = False,#音頻開關
　　　　enable_custom_object_detection: bool = False,#自定義對象檢測開關
　　　　enable_nav_map_feed: bool = None,#導航地圖開關
　　　　show_viewer: bool = False,#相機畫面開關
　　　　show_3d_viewer: bool = False,#3D畫面開關
　　　　requires_behavior_control: bool = True):#是否控制小V的行為系統
　　　　pass

可以有選擇的填入，普通情況下只需要小V的編號serial就行了。

 

三：所以接下來，我將嘗試對SDK進行源碼解析，看看其他語言是否也能實現控制功能。

 　　以下是剛剛下載下來的源碼目錄：

anki_vector目錄下存放的就是SDK庫源碼了，這是最重要的，接下來我就閱讀這一部分。

examples目錄下存放着一些應用例子，就是調用了anki_vector模塊的示例程序，包含了上面講的01_hello_world.py例程，如果還不清楚怎么調用anki_vector，可以多看看這部分。

剩下的都是一些無關緊要的文件，感興趣可以翻閱一下。

接下來打開anki_vector目錄：

雖然文件很多，但是並不復雜，沒有太多的嵌套，就一個平滑的文件列表，里面每一個py文件都實現了vector的一個控制功能（例如：背燈的控制由lights.py實現，照相的控制由camera.py實現），少數py文件用於實現基礎功能和最后匯總（例如robot.py用於匯總對vector的控制功能，在調用這個庫時只需要創建一個Robot類的對象，其他的操作全由這個對象間接完成）。

最重要的是，這些文件與官網API幾乎是一一對應，也就是說，每個文件內都封裝了一個功能類。

下面是在線文檔中的API，可以與上面的庫目錄對比着看，對每個API的說明也是對每個文件的說明：

具體每個類實現了哪些方法，可以點擊對應的在線文檔API進去看，也可以直接看源碼。

瀏覽了anki_vector庫的概貌之后，我們再回到最先講的hello world程序，看看在那幾個調用中，到底發生了什么。

 

四：hello world內部實現

 這個程序里，其實程序里面最不理解的就是這兩句：

args = anki_vector.util.parse_command_args()
with anki_vector.Robot(args.serial) as robot:
　　robot.say_text("Hello World")
　　pass

按照調用次序順藤摸瓜，從anki_vector模塊中找到util模塊，再從util模塊找到parse_command_args函數的實現，調用的時候是不帶參數的：

 parser是函數參數，在前面的例程中，我們沒有傳遞參數，默認是None。argparse是python的一個常用庫，最后發生的就是在87行設置一些默認參數，，88行返回。

再回到hello_world例程中，把返回的args直接傳遞給Robot的構造函數。

在with ... as ...語句中，創建了一個Robot類型的對象robot，然后隱式調用了Robot類的__enter__函數，在with ... as ...語句結束后會隱式調用__exit__函數。而里面所做的，就是調用connect成員函數和disconnect成員函數，可以簡單的認為是與你的vector機器人建立連接和斷開連接，connect函數內部代碼有點長，但是邏輯很簡單，就是初始化所有的功能類對象，這里不再展開：

然后先看一下say_text函數：創建一個protobuf定義的協議結構體對象，然后填充內容，然后使用gRPC發送給小V。gRPC是基於protobuf和http2.0的一種通用的RPC，使用它可以方便的生成服務端和客戶端代碼，由此也可以看出小V內部使用的是gRPC服務端。

看完這些后，大體明白了robot.py的作用，這個模塊不做具體的工作，只是簡單的把其他基礎模塊的功能集成進來，為外部用戶提供一個統一的接口。從這個文件的開頭也能看出，它引用了同級目錄下的幾乎所有模塊。

 

 五：功能模塊詳解

回頭仔細看看anki_vector目錄，里面除了python源文件，還包含了三個目錄，一個是messaging，一個是opengl，一個是configure。

打開messaging，一看里面的文件后綴就知道，這是在使用gRPC，google開源的通信框架，基於google protobuf實現，是一種高效率的、使用非常便捷的、被廣泛使用的通信方法，應該是用於電腦和vector的所有通信。雖然文件多，但是其實編碼時只需要編寫proto后綴的文件，用這些文件說明協議和RPC規則，編寫完proto文件后，運行google提供的工具，就能生成兩個同名的py文件。例如編寫了*.proto，運行工具就會生成*_pb2.py和*_pb2_grpc.py兩個文件，然后在源碼中使用這兩個生成的文件就行。而且用的是protobuf的第2版本，已經有第3版本了。

opengl目錄更不用說了，調用了openGL，應該是用於處理和渲染vector看到的圖像，或者輸入一些圖像給vector。

configure目錄內只有一個__main__.py，用於配置自己的vector的信息，使電腦有權限能夠連接特定vector。

 了解完這些，對SDK源碼已經有全局的了解。之后將調出幾個具體的功能講一下，所有功能的實現流程都大致相同。

----后面會持續更新----

-----未完期待-----

----轉載請注明出處（此頁面URL）----

anki vector robot SDK python 入門編程教程