# jf-iot-sdk

**Repository Path**: jftek/jf-iot-sdk

## Basic Information

- **Project Name**: jf-iot-sdk
- **Description**: 欢迎使用我司IOT_SDK编程手册，IOT_SDK是软件开发商在开发我司网络产品监控联网应用时的开发套件，提供了一系列函数接口给用户进行二次开发，降低了系统的开发门槛和难度，让第三方系统开发人员专注于其系统的业务功能实现。本文档详细描述了开发包的结构、各个函数实现的功能、接口及其函数之间的调用关系和示例实现。
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-05-06
- **Last Updated**: 2024-01-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# iot-sdk

## 概要说明

* iot-sdk是我司提供的一套函数接口，不受操作系统和硬件平台的限制，用户调用相关接口，传入音视频数据和相关配置信息，即可运行在用户的嵌入式设备上，依附此sdk，用户最终可以通过我司的小峰管家app实现音视频在线预览、远程对讲、远程升级、休眠设置以及其他远程控制功能。

* iot-sdk服务的客户群体是，有摄像机音视频功能开发能力，但不擅长云服务器部署和功能开发，同时又想让用户在手机端能远程查看摄像机音视频，并且实现对设备的远程控制。对于此类客户群体，我司的iot-sdk能提供很好的服务，客户只需要实现对于自身的操作系统和硬件平台的相关接口，其他的无需关注，设备连接服务器、音视频的上传、数据的收发等功能，iot-sdk均已实现。

## 效果验证流程

* 下载SDK包(如果没有对应编译器的SDK包，请发邮件到jf_iot_sdk@jftech.com，并附上交叉编译器的下载路径)
* 到[VIOT平台-产品开发](https://gitee.com/link?target=https%3A%2F%2Fviot.jftech.com%2Fproduct%23%2Fproduct%2Findex%3FmenuId%3D166%26lang%3Dzh)创建"摄像机"产品，在设备管理中申请免费授权码，点击生产文件下载，获取授权码。
* 修改SDK Demo中的app_main.c，将免费授权码里的uuid、authkey和pid写入到jftDemo()函数的配置中。
* 客户依据自身的操作系统和硬件平台自行实现JFT_OS目录下的接口函数以及Demo程序。
* 编译可执行程序，客户需要编译自己的Demo代码以及JFT_OS目录下的.c文件，同时链接下载的libxmapp.a。
* 手机上安装"小峰管家"app，可以通过自动扫描和手动添加两种方式将客户的设备添加到app中，进而实现音视频的预览和设备的远程控制。

## 正式对接流程
* 修改SDK Demo中的app_main.c，将免费授权码里的uuid、authkey和pid写入到jftDemo()函数的配置中。
* 客户可以自行设置wifi的连接方式，可以通过代码中写死的方式让设备连接固定的wifi，也可以让设备自行搜索wifi进行连接。
* 客户可以自行实现jfviot_WifiCallbackFunc函数，以实现wifi各种连接状态的回调。
* 关于音视频的硬件初始化以及音视频数据的读取，需要客户依据自己的操作系统和硬件平台自行实现。
* 音视频数据获取完毕后，可以调用jfviot_push_video_data将数据上传到服务器，注意：音视频数据是不带头的。
* 客户还需要依据自己的操作系统和硬件平台，实现JFT_OS目录下的相关接口，例如：对讲功能开始后，SDK会从服务器接收音频数据，然后调用jfviot_AudioTalkPutBuffer函数，客户需要依据自己的操作系统和硬件平台，将SDK接收到的音频数据写入到驱动，进而实现音频的播放。


## 支持

    开发文档: https://developer.jftech.com/
    联系邮箱: jf_iot_sdk@jftech.com 

## 开源协议

    ./LICENSE