极客工坊

 找回密码
 注册

QQ登录

只需一步,快速开始

查看: 81472|回复: 20

[深入浅出Energia开发第二讲]如何自己编写Arduino支持的C++类库

[复制链接]
发表于 2012-9-11 23:13:32 | 显示全部楼层 |阅读模式
本帖最后由 水乐天 于 2012-9-13 11:56 编辑

[之前的教程回顾[深入浅出Energia开发第一讲]51程序的移植
首先送给大家TI官方的火箭板宣传视频



    我们在上一讲中实现了一个TN901红外温度传感器51程序到Arduino程序的转换,如果代码越来越多这样程序的可维护性会随之降低,也不适合团度开发。我们应该把常用的文件封装成C++库,这样在复用的时候就会方便很多。
    首先让我们来看下官方的C++类库是怎样的结构,以官方的LCD类库为例,如下图所示:

上面的文件大体是这样的结构:
文件名 文件类型 文件说明
keywords.txt keywords.txt Arduino库色标文件
LiquidCrystal.h .h C++头文件
LiquidCrystal.cpp .cpp C++程序文件


以下几种文件的作用如下:

.h 头文件:头文件作为一种包含功能函数、数据接口声明的载体文件,用于保存程序的声明(declaration),而定义文件用于保存程序的实现 (implementation)。

.cpp 文件:C++程序源文件主要的逻辑写在这里。

keywords.txt 文件:用来定义库在程序中显示关键字的颜色。

下面让我们来做个实际的例子将我们昨天写的程序改造成C++类库 可以点击这里下载上一讲中的程序

首先我们来尝试下头文件的编写 有关宏定义的具体用法可以参见5楼zcbzjx的详细说明:)

  1. #ifndef TH901_H  //根据条件进行编译
  2. #define TH901_H
  3. //我们在这中间添加程序
  4. #endif            //条件编译结束
复制代码


我们在这中间添加程序主体的代码部分,首先来添加程序的头文件,需要引用什么都可以加进来

  1. #include <inttypes.h> //引用相关的头文件
复制代码


之后我们可以预定义一些需要的常量,这样维护起来比较方便,如果常量值改变只要统一修改这里就好

  1. #define TN901_OTADDRESS 0x4c
  2. #define TN901_ETADDRESS 0x66
  3. #define TN901_ENDADDRESS 0x0d
复制代码


接下来我们来定义变量和声明程序的方法,需要外部调用和访问的就声明成public,不需要外部访问的就声明为private

  1. class TN901     //定义类主体及类名
  2. {
  3.   public:  //以下定义为公共方法
  4.     short ET;   //环境温度输出
  5.     short OT;   //目标温度输出
  6.     void Init(int TN_Data,int TN_Clk,int TN_ACK); //程序初始化
  7.     void Read();  //读取方法
  8.     void ReadData(char flag); //读取指定地址的数据
  9.     int  GetData(); //获取数据
  10.   private:  //以下定义为私有方法
  11.     int _dataPin;  //数据引脚
  12.     int _clkPin;   //时钟引脚
  13.     int _ackPin;   //反馈引脚
  14.     unsigned char  Data[5];  //数据数组
  15. };
复制代码


这样我们一个头文件就写好了
  1. /**
  2. * TN901 Library
  3. * 说明: 台湾燃太红外TN901传感器库
  4. * 作者: 水乐天
  5. * Email: [email][email protected][/email]
  6. */

  7. #ifndef TH901_H  
  8. #define TH901_H


  9. #include <inttypes.h> //引用相关的头文件

  10. #define TN901_OTADDRESS 0x4c
  11. #define TN901_ETADDRESS 0x66
  12. #define TN901_ENDADDRESS 0x0d


  13. class TN901     //定义类主体及类名
  14. {
  15.   public:  //以下定义为公共方法
  16.     short ET;   //环境温度输出
  17.     short OT;   //目标温度输出
  18.     void Init(int TN_Data,int TN_Clk,int TN_ACK); //程序初始化
  19.     void Read();  //读取方法
  20.     void ReadData(char flag); //读取数据
  21.     int  GetData(); //获取数据
  22.   private:  //以下定义为私有方法
  23.     int _dataPin;  //数据引脚
  24.     int _clkPin;   //时钟引脚
  25.     int _ackPin;   //反馈引脚
  26.     unsigned char  Data[5];  //数据数组
  27. };

  28. #endif            //程序结束
复制代码


接下来我们来书写程序的主体,就是CPP文件。首先我们引用已经写好的程序头文件
  1. #include "TN901.h"
复制代码


之后我们引用一些需要的库文件,需要哪些可以参见标准C++的库文件说明

  1. #include "TN901.h"

  2. #include <stdio.h>
  3. #include <string.h>
  4. #include <inttypes.h>
  5. #include "Arduino.h"
复制代码


然后我们逐一实现在头文件中定义的方法,注意类型要与定义类型相对应。所有的方法都要属于你定义的类名,格式如下

  1. 类名::方法名
复制代码



另外i啊我们要为程序的封装考虑程序应有的结构,总之是怎样使你的库使用起来最方便,在一般的逻辑中尽量减少调用的次数。我们可以把程序的逻辑分割为几个部分来书写。如:

  1. 1.初 始 化
  2. 2.实现功能
  3. 3.显示数据
复制代码


当然这个逻辑以具体的程序为准。

我们来尝试写第一个初始化的方法,这样我们可以自己定义程序的端口。

  1. //初始化TN901传感器
  2. void TN901::Init(int TN_Data,int TN_Clk,int TN_ACK)
  3. {
  4.   //定义私有端口
  5.   _dataPin=TN_Data;
  6.   _clkPin=TN_Clk;
  7.   _ackPin=TN_ACK;

  8.   pinMode(_clkPin, INPUT);
  9.   pinMode(_ackPin, OUTPUT);
  10.   digitalWrite(_ackPin,HIGH);
  11. }
复制代码


然后我们书写程序的主要逻辑部分

  1. //读取数据
  2. void TN901::Read()
  3. {
  4.   digitalWrite(_ackPin,LOW);
  5.   ReadData(TN901_OTADDRESS);//目标温度的第一个字节为0x4c   
  6.   if((Data[0]==TN901_OTADDRESS)&&
  7.      (Data[4]==TN901_ENDADDRESS))//每帧的最后一个字节为0x0d   
  8.   {   
  9.     GetData_OT();  
  10.   }

  11.   delay(1); //等待1毫秒
  12.         
  13.   digitalWrite(_ackPin,LOW);
  14.   ReadData(TN901_ETADDRESS);//环境温度的第一个字节为0x66      

  15.   if((Data[0]==TN901_ETADDRESS)&&
  16.      (Data[4]==TN901_ENDADDRESS))//每帧的最后一个字节为0x0d   
  17.   {   
  18.     GetData_ET();
  19.   }
  20. }
复制代码


最后我们逐一实现程序的运算过程

  1. //读取数据
  2. void TN901::ReadData(char flag)
  3. {
  4.   char i,j,k;
  5.   byte BitState = 0;          //每次发七帧
  6.   for(k=0;k<7;k++)
  7.   {
  8.     for(j=0;j<5;j++)        //每帧5个字节
  9.     {
  10.       for(i=0;i<8;i++)
  11.       {
  12.         int temp= digitalRead(_clkPin);
  13.         while(temp)
  14.         {
  15.           temp = digitalRead(_clkPin);
  16.         }
  17.         temp= digitalRead(_clkPin);
  18.         BitState= digitalRead(_dataPin);
  19.         Data[j]= Data[j]<<1;
  20.         Data[j]= Data[j]|BitState;
  21.         
  22.         while(!temp)
  23.         {
  24.           temp = digitalRead(_clkPin);
  25.         }
  26.       }
  27.     }
  28.    if(Data[0]==flag)  k=8;
  29.   }

  30.   digitalWrite(_ackPin,HIGH);
  31. }

  32.   //计算环境温度
  33. void TN901::GetData_ET()   
  34. {      
  35.   ET=(Data[1]<<8)|Data[2];   
  36.   ET = int(((float)ET/16 - 273.15)*100);      
  37. }   

  38. //计算目标温度
  39. void TN901::GetData_OT()   
  40. {   
  41.   OT=(Data[1]<<8)|Data[2];   
  42.   OT = int(((float)OT/16 - 273.15)*100);      
  43. }  
复制代码


这样我们的程序就写好了,需要完整代码的朋友可以点击这里下载

之后我们来尝试为我们的库编写一个范例程序来测试我们的程序是否运行正常。

  1. #include <TN901.h>  //引用库文件
  2. TN901 tn;           //实 例 化
  3. void setup()
  4. {
  5.     Serial.begin(9600);
  6.     tn.Init(7,9,8);  //初 始 化
  7. }

  8. void loop()
  9. {
  10.    tn.Read();        //数据读取
  11.    SerialValue();
  12.    delay(200);
  13. }

  14. void SerialValue()
  15. {
  16.    Serial.print("OT: ");
  17.    Serial.print(tn.OT, DEC);  //输出目标温度
  18.    Serial.println(" C");
  19.    Serial.print("ET: ");
  20.    Serial.print(tn.ET, DEC);  //输出环境温度
  21.    Serial.println(" C");
  22. }
复制代码


好了,我们看到虽然我们花了一点时间编写了库文件,但是在我们使用程序的时候可以非常方便的调用,而且这样逻辑会比较清晰。呵呵。

最后送给大家一个小礼物,就是如何为我们的库编写色标文件,色标文件就是定义你的库中的方法在编译器中显示的颜色
没有色标文件的库显示起来是这样的:

我们可以看到库文件的类名和方法名都是黑色的这样看起来不是很清楚。加上色标文件之后是这样的:

我们可以看到TN901这样的类名都被加亮了这样看起来要清楚许多。

实现这个需要定义一个色标文件放在库文件的目录中,格式如下
  1. #######################################
  2. # Syntax Coloring Map For 你的类名
  3. #######################################

  4. #######################################
  5. # Datatypes (KEYWORD1) 数据类型关键字
  6. #######################################

  7. TN901        KEYWORD1

  8. #######################################
  9. # Methods and Functions (KEYWORD2) 方法类型关键字
  10. #######################################

  11. Init        KEYWORD2
  12. Read        KEYWORD2
  13. ReadData        KEYWORD2
  14. GetData        KEYWORD2

  15. #######################################
  16. # Constants (LITERAL1)  常量类型关键字
  17. #######################################

  18. ET        LITERAL1
  19. OT        LITERAL1
复制代码


这样我们的色标文件就写好了,我们把它保存成文件名为keywords.txt的文件放在库文件目录下就可以了。

当我们些库文件全部做好了之后我们就可以把这些文件放在,这样的目录下
  1. energia:energia-0101E0008\hardware\msp430\libraries\
  2. arduino:arduino-1.0.1-windows\arduino-1.0.1\libraries\
复制代码


这样当你重新打开官方编译器的时候可以看到如下的内容

这样我们就可以很方便的调用了。

下一讲中我将简单说一下google code的使用,这样大家可以把程序放在网上进行分享。
本例的文件下载

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?注册

x

评分

参与人数 2 +40 收起 理由
Ansifa + 30 这个教程好啊!
幻生幻灭 + 10 此版真火啊!

查看全部评分

回复

使用道具 举报

发表于 2012-9-12 07:00:25 | 显示全部楼层
呵呵,还没起床?
回复 支持 反对

使用道具 举报

发表于 2012-9-12 18:13:27 | 显示全部楼层
顶顶~,佩服,向老大学习编程!
回复 支持 反对

使用道具 举报

 楼主| 发表于 2012-9-12 19:50:05 | 显示全部楼层
更新TI官方火箭板视频
回复 支持 反对

使用道具 举报

发表于 2012-9-13 09:45:53 | 显示全部楼层
本帖最后由 zcbzjx 于 2012-9-13 09:50 编辑

既然这样我也加个基础文章吧。
C语言之详解#ifdef等宏
    这几个宏是为了进行条件编译。一般情况下,源程序中所有的行都参加编译。但是有时希望对其中一部分内容只在满足一定条件才进行编译,也就是对一部分内容指定编译的条件,这就是“条件编译”。有时,希望当满足某条件时对一组语句进行编译,而当条件不满足时则编译另一组语句。
    条件编译命令最常见的形式为:
    #ifdef 标识符
    程序段1
    #else
    程序段2
    #endif
     
    它的作用是:当标识符已经被定义过(一般是用#define命令定义),则对程序段1进行编译,否则编译程序段2。
    其中#else部分也可以没有,即:
    #ifdef
    程序段1
    #denif
     
    这里的“程序段”可以是语句组,也可以是命令行。这种条件编译可以提高C源程序的通用性。如果一个C源程序在不同计算机系统上系统上运行,而不同的计算机又有一定的差异。例如,我们有一个数据类型,在Windows平台中,应该使用long类型表示,而在其他平台应该使用float表示,这样往往需要对源程序作必要的修改,这就降低了程序的通用性。可以用以下的条件编译:
    #ifdef WINDOWS
    #define MYTYPE long
    #else
    #define MYTYPE float
    #endif
     
    如果在Windows上编译程序,则可以在程序的开始加上
    #define WINDOWS
     
    这样则编译下面的命令行:
    #define MYTYPE long
     
    如果在这组条件编译命令之前曾出现以下命令行:
    #define WINDOWS 0
     
    则预编译后程序中的MYTYPE都用float代替。这样,源程序可以不必作任何修改就可以用于不同类型的计算机系统。当然以上介绍的只是一种简单的情况,可以根据此思路设计出其它的条件编译。
    例如,在调试程序时,常常希望输出一些所需的信息,而在调试完成后不再输出这些信息。可以在源程序中插入以下的条件编译段:
    #ifdef DEBUG
    print ("device_open(%p)\n", file);
    #endif
     
    如果在它的前面有以下命令行:
    #define DEBUG
     
    则在程序运行时输出file指针的值,以便调试分析。调试完成后只需将这个define命令行删除即可。有人可能觉得不用条件编译也可达此目的,即在调试时加一批printf语句,调试后一一将printf语句删除去。的确,这是可以的。但是,当调试时加的printf语句比较多时,修改的工作量是很大的。用条件编译,则不必一一删改printf语句,只需删除前面的一条“#define DEBUG”命令即可,这时所有的用DEBUG作标识符的条件编译段都使其中的printf语句不起作用,即起统一控制的作用,如同一个“开关”一样。
    有时也采用下面的形式:
    #ifndef 标识符
    程序段1
    #else
    程序段2
    #endif
     
    只是第一行与第一种形式不同:将“ifdef”改为“ifndef”。它的作用是:若标识符未被定义则编译程序段1,否则编译程序段2。这种形式与第一种形式的作用相反。
    以上两种形式用法差不多,根据需要任选一种,视方便而定。
    还有一种形式,就是#if后面的是一个表达式,而不是一个简单的标识符:
    #if 表达式
    程序段1
    #else
    程序段2
    #endif
     
    它的作用是:当指定的表达式值为真(非零)时就编译程序段1,否则编译程序段2。可以事先给定一定条件,使程序在不同的条件下执行不同的功能。
    例如:输入一行字母字符,根据需要设置条件编译,使之能将字母全改为大写输出,或全改为小写字母输出。
    [pre lang="c" line="1"]#define LETTER 1
    main()
    {
    char str[20]="C Language",c;
    int i="0";
    while((c=str)!='\0'){
    i++;
    #if LETTER
    if(c>='a'&&c<='z') c="c-32";
    #else
    if(c>='A'&&c<='Z') c="c"+32;
    #endif
    printf("%c",c);
    }
    } [/code]
     
    运行结果为:C LANGUAGE
    现在先定义LETTER为1,这样在预处理条件编译命令时,由于LETTER为真(非零),则对第一个if语句进行编译,运行时使小写字母变大写。如果将程序第一行改为:
    #define LETTER 0
     
    则在预处理时,对第二个if语句进行编译处理,使大写字母变成小写字母(大写字母与相应的小写字母的ASCII代码差32)。此时运行情况为:
    c language
    有人会问:不用条件编译命令而直接用if语句也能达到要求,用条件编译命令有什么好处呢?的确,此问题完全可以不用条件编译处理,但那样做目标程序长(因为所有语句都编译),而采用条件编译,可以减少被编译的语句,从而减少目标的长度。当条件编译段比较多时,目标程序长度可以大大减少。


浅谈#ifdef在软件开发中的妙用

  笔者从事UNIX环境下某应用软件的开发与维护工作,用户分布于全国各地,各用户需要的基本功能都是一样的,但在某些功能上要随着需求变化,不断加以升级,要想实现全国各地用户的升级工作是很困难的,而我们则只是利用E-mail发送补丁程序给用户,这些补丁程序都是在一套软件的基础上不断地修改与扩充而编写的,并由不同的标志文件转入到不同的模块,虽然程序体积在不断扩大,但丝毫不影响老用户的功能,这主要是得益于C程序的#ifdef/#else/#endif的作用。


  我们主要使用以下几种方法,假设我们已在程序首部定义#ifdef DEBUG与#ifdef TEST:

  1.利用#ifdef/#endif将某程序功能模块包括进去,以向某用户提供该功能。

  在程序首部定义#ifdef HNLD:

  [pre lang="c" line="1"]#ifdef HNLD

  include"n166_hn.c"

  #endif[/code]

  如果不许向别的用户提供该功能,则在编译之前将首部的HNLD加一下划线即可。

  2.在每一个子程序前加上标记,以便追踪程序的运行。
  1. #ifdef DEBUG

  2.   printf(" Now is in hunan !");

  3.   #endif
复制代码
3.避开硬件的限制。有时一些具体应用环境的硬件不一样,但限于条件,本地缺乏这种设备,于是绕过硬件,直接写出预期结果。具体做法是:
  1. #ifndef TEST

  2.   i=dial();

  3.   //程序调试运行时绕过此语句

  4.   #else

  5.   i=0;

  6.   #endif
复制代码
调试通过后,再屏蔽TEST的定义并重新编译,即可发给用户使用了。

# ifdef  #ifndef 等用法(转)

  头件的中的#ifndef,这是一个很关键的东西。比如你有两个C文件,这两个C文件都include了同一个头文件。而编译时,这两个C文件要一同编译成一个可运行文件,于是问题来了,大量的声明冲突。

还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用,你都要加上这个。一般格式是这样的:
  1. #ifndef <标识>
  2. #define <标识>

  3. ......
  4. ......

  5. #endif
复制代码
<标识>在理论上来说可以是自由命名的,但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写,前后加下划线,并把文件名中的“.”也变成下划线,如:stdio.h
  1. #ifndef _STDIO_H_
  2. #define _STDIO_H_

  3. ......

  4. #endif
复制代码
2.在#ifndef中定义变量出现的问题(一般不定义在#ifndef中)。
  1. #ifndef AAA
  2. #define AAA
  3. ...
  4. int i;
  5. ...
  6. #endif
复制代码
里面有一个变量定义
在vc中链接时就出现了i重复定义的错误,而在c中成功编译。

结论:

(1).当你第一个使用这个头的.cpp文件生成.obj的时候,int i 在里面定义了当另外一个使用这个的.cpp再次[单独]生成.obj的时候,int i 又被定义然后两个obj被另外一个.cpp也include 这个头的,连接在一起,就会出现重复定义.

(2).把源程序文件扩展名改成.c后,VC按照C语言的语法对源程序进行编译,而不是C++。在C语言中,若是遇到多个int i,则自动认为其中一个是定义,其他的是声明。

(3).C语言和C++语言连接结果不同,可能(猜测)时在进行编译的时候,C++语言将全局
变量默认为强符号,所以连接出错。C语言则依照是否初始化进行强弱的判断的。(参考)

解决方法:

(1).把源程序文件扩展名改成.c。

(2).推荐解决方案:
.h中只声明 extern int i;在.cpp中定义

<x.h>
#ifndef __X_H__
#define __X_H__
extern int i;
#endif //__X_H__
<x.c>
int i;

注意问题:

(1).变量一般不要定义在.h文件中。

评分

参与人数 1 +30 收起 理由
Ansifa + 30

查看全部评分

回复 支持 反对

使用道具 举报

发表于 2012-10-10 12:25:39 | 显示全部楼层
支持下。。。
回复 支持 反对

使用道具 举报

发表于 2012-10-22 16:44:28 | 显示全部楼层
好好学习下!
回复 支持 反对

使用道具 举报

发表于 2012-11-20 12:47:18 | 显示全部楼层
mark  ,,,以后学习。。。
回复 支持 反对

使用道具 举报

发表于 2012-11-28 23:52:34 | 显示全部楼层
好帖子……回复下以后慢慢学习……
回复 支持 反对

使用道具 举报

发表于 2013-1-15 00:26:38 | 显示全部楼层
好.............
回复 支持 反对

使用道具 举报

发表于 2013-2-26 18:10:20 | 显示全部楼层
水平真高啊,到这地步得学多久!
回复 支持 反对

使用道具 举报

发表于 2013-3-8 10:50:29 | 显示全部楼层
{:soso_e104:}...从大哥这里可以学到很多东西...
回复 支持 反对

使用道具 举报

发表于 2014-4-21 12:39:26 | 显示全部楼层
有用。。。。
回复 支持 反对

使用道具 举报

发表于 2014-6-28 21:32:12 | 显示全部楼层
thank  you!
回复 支持 反对

使用道具 举报

发表于 2014-8-25 11:22:40 | 显示全部楼层
c++  慢慢学着
回复 支持 反对

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则 需要先绑定手机号

Archiver|联系我们|极客工坊

GMT+8, 2024-3-28 22:12 , Processed in 0.060242 second(s), 35 queries .

Powered by Discuz! X3.4 Licensed

Copyright © 2001-2021, Tencent Cloud.

快速回复 返回顶部 返回列表