相关说明mopencpu接口如果您有任何模组产品及手册评论疑问想法或者无法从

： 及其存在的人享有的软件，除非获得相关权利人/添加

本文档主要对M6315OpenCPU提供的用户接口进行说明，包括但不限于 回值、重要宏定义和注意事项。对于提供的用户接口的具体使用，请参考cmiot_test_*.c系列接口使用示例文 文档前 音 SYSTEM 互斥 信号 定时 定时 闹 内 文 读 网络 87 LBS定 协议 API 其 附 ptUartCfguart_id串口 uart_id串口uint16_tcm_serial_read(constCMIOT_UART_ID_Euart_id,uint8_t*pBuf,uint16_tlen,uint16_tuart_id串口pBuflen大于等于 -uart_id串口pBuflen大于等于 -uart_id串口handle 示例代码参考cmiot_test_uart.cspeedresoucebusyVOIDaddrmemAddrpdatalen ---resouceaddrmemAddrlen0resoucebusyaddrmemAddrpdataresoucebusyaddrmemAddrpdataresoucebusy示例代码参考cmiot_test_i2c.c使用I2C(*irqHandler)(uint32_tparam),uint32_tirqParam);该函数用于设置GPIOgpio_idGPIO01防抖动irqHandlerparam中断处理函数输入参数（irqParamirqParam该函数用于删除GPIOgpio_idGPIO该函数用于设置GPIO为gpio_idGPIO该函数用于设置GPIO为gpio_idGPIO该函数用于拉高GPIO电平gpio_idGPIO该函数用于拉低GPIO电平gpio_idGPIO该函数用于GPIO电gpio_idGPIO01gpio_idGPIO0gpio_idGPIOCMIOT_GPIO_0对应模组引脚30,//0GPIO;1SPI_CS 开机默认GPIOCMIOT_GPIO_1对应模组引脚31,//0GPIO;1SPI_MISO 开机默认GPIOCMIOT_GPIO_2对应模组引脚32,//0GPIO;1SPI_CLK 开机默认GPIOCMIOT_GPIO_3对应模组引脚33,//0GPIO;1SPI_MOSI 开机默认GPIOCMIOT_GPIO_4对应模组引脚19,//GPIOCMIOT_GPIO_5对应模组引脚16, //0GPIO;132KOUT 开机默认GPIOCMIOT_GPIO_6对应模组引脚20, //0GPIO;1I2C_SCL 开机默认I2C_SCLCMIOT_GPIO_7对应模组引脚21, //0GPIO;1I2C_SDA 开机默认I2C_SDACMIOT_GPIO_8对应模组引脚23, //GPIOCMIOT_GPIO_9对应模组引脚 CMIOT_GPIO_10对应模组引脚28,//0GPIO;1UART2_RX;2LPG 开机默认UART2_RXCMIOT_GPIO_11对应模组引脚29,//0GPIO;1UART2_TX;2 开机默认uint16_t该函数用于获取ADC值ADCchannl音频通道 -int8_tint8_tint8_t当前音频通道保存至NV中 -int8_t该函数用于获取NVchannl音频通道volume通道音量(0- -channl音频通道大于等于 通道音当前音频通道音量保存至NV中channl音频通道 -channl音频通道大于等于 通道音(*callback)(uint32_tresult));audio_buffbuff_lenaudio_typecallback0-0-audio_fileaudio_typecallback0-0-VOID该函数用于TTS语mode12tts_data内tts_data_len0-0-void该函数用于停止TTS语 void该函数用于输出波cm_gpio_set_type切换模式。 voidcm__pwtstart(UINT16noteFreq,UINT16该函数用于输出波(pwt,可调noteFreqlevel占空比（1-PWT29UART2_TX，使用前请调用cm_gpio_set_type voidcm_该函数用于关闭 该函数用于输出波periodonTime void该函数用于关闭doDelay,CMIOT_SPI_DELAY_TdiDelay,CMIOT_SPI_DELAY_TcsDelay,CMIOT_SPI_DELAY_TcsPulse);该函数用于配置spi（SPIcs片选（对应相应的引脚clkFallEdge0cs片选（对应相应的引脚input_enspi_Freq0cs片选（对应相应的引脚cs片选（对应相应的引脚 cs片选（对应相应的引脚 cs片选（对应相应的引脚 2cs片选（对应相应的引脚data大于等于 cs片选（对应相应的引脚datalength大于等于 cs片选（对应相应的引脚write_dataread_data数length大于等于 cs片选（对应相应的引脚大于等于 flash_block_little_size,uint32_tflash_block_size);该函数用于设置flash相关大小（当使用SPI接口FLASH，并需要使用文件系统操作时使用flash_sector_size扇区大小（flash_page_size页大小（flash_block_little_size块大小（little）（flash_block_little_size块大小（--int32_tcm_spi_flash_vfs_set_cmd(uint8_tflash_write_enable,uint8_tflash_read_status,uint8_tflash_read_id,uint8_tflash_sector_erase,uint8_tflash_block_erase,uint8_tflash_block_little_erase,uint8_tflash_page_program,uint8_tflash_fast_read)该函数用于设置flash相关命令（当使用SPI接口FLASH，并需要使用文件系统操作时使用flash_write_enable（flash_read_status（flash_read_id（flash_sector_erase（flash_block_erase（flash_block_little_erase（flash_page_program（little）（flash_fast_read（ -该函数用于初始化flash文件系统 -SPI大小为16字节，单独调用cm_spi_writedata/cm_spi_readdata函数读写时请及时缓冲区数据，SPI_MISO对应模组引脚SPI_MOSI对应模组引脚使用SPIFLASH，并使用cm_spi_flash_vfs_init接口加载到文件系统中时，SPI不可用于其他操作，并且使用文件系统接口函数操作FLASH时，文件路径需在/flash下，否则操作的则是模组本身的flash。SYSTEMptrVer64 HANDLE互斥锁mutex互斥锁mutex互斥锁mutex互斥锁信号量hSem hSem hSem uint32_t该函数用于获取系统启动后运行的时间，单位msHANDLEcm_taskcreat(CMIOT_TASK_ENTRYpTaskEntry,uint16_tu16StackSize,uint16_tu16Priority,PCSTRpTaskEntry函数指u16StackSizeu16Priority可用优先级范围CMIOT_TASK_PRIORITY_MIN至pTaskName线程名（字符串Task taskHandle要删除线程的Task 或htask要挂起线程的Task htask要挂起线程的Task HANDLE该函数用于获取当前线程的Task2.5.62.5.72.5.62.5.7 htask要查询线程的Taskvoidcm_taskmsgrecv(HANDLEhUserTask,CMMsg_ThUserTask线程的TaskptMsghUserTask线程的TaskptMsgptMsghTaskcallbackParamu32msecondestimetimeint8_ts8TimeZonetimedate_timeutc_secdate_timeyear-年month–月dayofweekday–日hour–时minutesecondvoid同时存在delay超时时间s36func_ptrperiod同时存在delay超时时间ms2func_ptrperiodboolcm_starttimer_withparam(uint8_tmode,uint32_tdelay,CMIOT_TimerCallbackfunc_ptr,CMIOT_TIMER_MODE_Eperiod,void*param);0时间单位ms（2分钟1时间单位s（36小时delayfunc_ptrperiodfunc_ptr uint32_tcm_mstotick(uint32_t该函数用于毫秒数转为Ticku32Msu32Ms超时时间func_ptrpParam func_ptrint32_tcm_set_alarm(uint8_treccurr,uint8_t*time,uint8_tindex,uint8_ttype,VOID(*callback)(uint8_tindex,uint8_ttype));reccurr08timeindextype012callback0-index闹钟0-list0-串口串口01wakeup_timems（5S,只对串口唤醒有效voidnSizevoidvoid (voidppCM_HEAP_STATUS{nUsedSizenTotalSize}--filenamefd int32_tcm_file_read(int32_tfd,uint8_t*buf,uint32_tfdbufreadLen -int32_tcm_file_write(int32_tfd,uint8_t*buf,uint32_twrifdbufreadLen pcszFileName -pcszFileName fd -pathlength--oldpathneth新文件 -fdoffestbase01 0-fd0 _size,uint32_ttotal_size_size total_sizetotal_size_size该函数用于获取flash使用情况（使用 _size,uint32_t -O_RDONLY只读方式打开文件O_WRONLY只写方式打开文件O_RDWR读写方式打开文件O_APPEND 打开文件时，若文件存在则初始化文件（改变文件长度为0） FS_SEEK_SET文件头FS_SEEK_CURFS_SEEK_END文件尾网络该函数用于获取GPRScontextIdPDPstat

0,未附着1，正在附着该函数用于获取GSMstat0123BOOLcontextIdPDP contextIdPDP 该函数用于DNS解析contextIdPDPfirstAddrDNSsecondAddrDNS 该函数用于获取PDPIPcontextIdPDP 该函数用于获取APN地址apnapnuserapnpwd 该函数用于设置apnapnuserapnpwd stat信息0未1已2未3被45已查询GPRS网络状stat信息0未1已2未3被45已cellid socketIdnProtocolBOOLcm_socket_connect(int32_tsocketId,uint32_tremoteIP,uint16_tsocketIdSOCKETID号，与cm_socket_createremoteIPIPremotePortsocketIdSOCKETID号，与cm_socket_create socketIdSOCKETID号，与cm_socket_createpDatanDataSize待发送数据长度（大于等于 -socketIdSOCKETID号，与cm_socket_create大于等于 -socketIdSOCKETID号，与cm_socket_createCFW_SOCKET_NONE：socket无效func PLETEip该函数用于查询socket是否可接收该函数用于查询socket是否可接收socketId- ipaddrpointIPipaddrIP (*socket_callback)(u32socket_id,u32datalen,u32IDBOOL BOOL BOOLBOOL CurrCellInfo当前小区信息（sizeNeighborCellInfo附件小区信息（sizeLBSkey_bufbuf_len100callback回调函数void*cm_get_refloc_callbackboolresult,UINT8lat_str经度（20lng_str纬度（20该函数用于获取http数据urlHTTP地callback0-total,uint32_tsum,uint32_tcur,interr));该函数用于获取http数据（异步urlHTTP地timeout连接超时时，调用回调函数，回调函数参数全为NULL00-该函数用于设置自定义http报头（异步有效01header自定义httpheader_len自定义http0-010-void该函数用于主动关闭http连接（异步有效0-int3201-sum,uint32_tcur));urlmode01callback0-方式urlmode01timeout连接超时时，调用回调函数，回调函数参数全为NULL00-callback-01230-VOID该函数用于RSfotaint32_tcm_set_mqtt_cfg(uint32_tid,uint32_tkeepAlive,uint32_ttimeout,uint32_tMSG_T*connect_config,boolcleansession,VOID(*callback)(uint32_tresult,uint8_tid,uint16_tmsgid,CMIOT_MQTT_MSG*mqtt_msg));该函数用于设置MQTT参数idmqttid(0-5)(本地通道keepAlive保活时间（1-timeout命令响应超时时间（1-rsnd_tm重传次数(0-是否使用will是否保留willwill消息QoS(0-willcleansession服务器断开连接后是否清空该信返回结果,见所属MQTTID(0-消息ID,SUB/USUB/PUB有topicname长度0int32_tcm_mqtt_open(uint8_tid,uint8_t*host,uint32_t该函数用于打开MQTT客户端idmqttid(0-5)(本地通道hostport -该函数用于关闭MQTT客户端该函数用于关闭MQTT客户端idmqttid(0-5)(本地通道 int32_tcm_mqtt_connect(uint8_tid,uint8_t*_id,uint32_t_id_len,uint8_t*user,uint32_tuser_len,uint8_t*password,uint32_tpassword_len);idmqttid(0-5)(本地通道_id_id_lenid长user_lenpasswordpassword_len长- -int32_tcm_mqtt_pub(uint8_tid,uint16_tmsgid,uint8_tqos,boolretain,uint8_t*topic,uint32_ttopic_len,uint8_t*payload,uint32_tpayloadlen);该函数用于发布MQTT消息idmqttid(0-5)(本地通道msgid1-qos0-retain是否保留推送消息（0-topictopic_len发布的消长payloadpayloadlen -int32_tcm_mqtt_sub(uint8_tid,uint16_tmsgid,uint8_t*topic,uint32_ttopic_len,uint8_t该函数用于订阅MQTT消息idmqttid(0-5)(本地通道msgid1-qos0- -int32_tcm_mqtt_unsub(uint8_tid,uint16_tmsgid,uint8_t*topic,uint32_t该函数用于取消订阅MQTT消息idmqttid(0-5)(本地通道msgid1-topictopic_len订阅的消长 -int32_tcm_mqtt_set_dup(uint8_tid,bool该函数用于设置duppubpub1idmqttid0-5)（dup--int32_tcm_mqtt_set_dup(uint8_tid,bool该函数用于获取dup标志idmqttid(0-5)(本地通道dup -该函数用于ssl初始化ssl_cfgsslid,支持(0-7)8路ssl_verSSL01234sec_lvl012cert_type设置类123ca_certCA_cert_cert_len_key_key_len0-该函数用于打开ssl功能ssl_idsslid,支持(0-7)8路connect_type指定该路sslconnect_id指定需要使用该路ssl使用sockedid（1-使用mqttid（0-0-该函数用于关闭ssl（该路sslssl_idsslid,支持(0-7)8路0-9 BOOLcm_sms_send(constuint8_t*pcszPhoneNo,constuint8_t*pcMessage,uint32_tu32MessageLen,uint32_tpdudataLen,void(*callback)(int32_tresult));pcszPhoneNo,字符串(只对文本模式有效，在PDU模式下设为字符集影响，默认GSM，可通过cm_settechset函数设置）u32MessageLenpdudataLenpduPDUcallback