.. _beginnger:

------------------------------------------
GomerX SDK 开始使用SDK
------------------------------------------


SDK 能做什么?
_____________

GomerX  SDK （以下简称 SDK）是一套面向 GomerX 系列产品的开发工具包，
目前支持的产品包括 。通过 SDK， 用户可以实现在PC上控制机器人运动以及获取机器人传感器的相关信息 


第一个SDK程序
_____________

接下来本文档将从如何获取 GomerX 机器人的相关信息来编写第一个 SDK 程序3

- 首先在GOMERX-SDK-MASTER目录下新建一个文件夹usr，用于保存用户自己的程序代码

- 然后打开VScode，点击文件-新建文件，并保存为py后缀格式的python文件，命名myrobot.py

.. warning::目录与文件名使用英文

.. image::2022-04-19_11-37-45.png

- 打开myrobot.py文件，开始编写程序

- 从安装的的 `gomerx` 包中导入自己需要的模块，这里我们导入包含获取机器人信息的 `robot` 模块::

    from gomerx import robot

- 接下来先定义一个 `robot_name` 变量来存放机器人的名字，并实例化一个机器人对象::

    robot_name = 'GomerX_6e09ba'
    my_robot = robot.Robot(robot_name)

-  通过 `robot` 模块中的 get_version 方法可以得到机器人的版本,并通过print函数打印出来::

    version = my_robot.get_version()
    print("Robot Version: ", version)

-  通过 `robot` 模块中的 get_sn 方法可以得到机器人的 sn 号,并通过print函数打印出来::

    sn = my_robot.get_sn()
    print("Robot SN: ", sn)

-  通过 `robot` 模块中的 get_battery 方法可以得到机器人的剩余电量,并通过print函数打印出来::

    battery = my_robot.get_battery()
    print("Robot Battery: ", battery)

示例文档中提供了获取机器人相关信息的例程 :file:`/examples/00_basic/02_robot_info.py`

.. literalinclude:: ./../../../examples/00_basic/02_robot_info.py
   :language: python
   :linenos:
   :lines: 1-12


运行编写的程序
___________________

1. 接下来本文档将演示如何使用 SDK ，并运行编写的程序

.. warning::运行程序前，保证机器人WiFi连接正常，自己编写的程序中已修改robot_name为本机器人WiFi名称

-  在终端面板输入, 将我们的终端切换到当前程序的路径下::

    cd .\examples\00_basic\ 
    -- cd 切换目录
    -- dir或ls显示当前目录文件
    -- cd.. 回到上层目录

.. warning::运行程序需要在程序当前目录下运行，否则python解释器无法找到程序文件

-  使用 python 运行示例程序::

    python .\01_sdk_version.py

.. image:: ./../images/win10_use_SDK_examples_setup1.png

2. 结束运行程序
- 关闭终端可以结束运行程序
- 部分程序中按Esc可以结束运行程序

示例程序讲解
___________________
1. 更多的示例程序路径为 ``/gomerx-sdk/examples``

2. 示例程序包含了主要的功能展示

    00_basic 基础功能

    01_motion 电机运动与机械臂运动相关

    02_led 小车前方LED灯控制

    03_camera 小车摄像头控制

    04_skill 人脸检测、字母数字识别、巡线检测等人工智能程序

    05_opencv 读取保存图像与图形绘制
    
    06_project 果小智配套智慧医院主题套件完整示例程序