Difference between revisions of "Matrix - Buzzer"

From FriendlyELEC WiKi
Jump to: navigation, search
(Applications)
 
(17 intermediate revisions by 2 users not shown)
Line 9: Line 9:
 
* 3 PIN interface
 
* 3 PIN interface
 
* PCB dimension (mm): 16 x 24
 
* PCB dimension (mm): 16 x 24
[[File:buzzerpcb.png|frameless|400px|无源蜂鸣器PCB]]
+
[[File:buzzerpcb.png|frameless|400px|Buzzer PCB]]
  
 
* Pin Description:
 
* Pin Description:
Line 23: Line 23:
 
|}
 
|}
  
==工作原理==
+
==Basic Device Operation==
无源蜂鸣器没有内部驱动电路,因此无源蜂鸣器工作的理想信号是方波。如果给预直流信号蜂鸣器是不响应的,因为磁路恒定,钼片不能振动发音。所以GPIO驱动无源蜂鸣器需要把GPIO的值拉高以后再拉低来产生振荡,而振荡的频率由GPIO从高拉低之间的时间决定,可以通过改变这个时间使无源蜂鸣器发出频率不同的声音。
+
A passive buzzer will not tweet if DC signals are used; instead, you need to use square waves whose frequency is between 2K and 5K to drive it. If you use GPIO signals to drive it you need to pull the GPIO high first and then low to generate oscillation. The oscillation frequency is generated by the time in which GPIO signals turn from high to low. The buzzer will generate different sounds based on different frequencies.
  
==下载Matrix源码==
+
==Applications==
Matrix配件相关的代码是完全开源的,统一由一个仓库进行管理:git://github.com/friendlyarm/matrix.git <br>
+
===Connect to NanoPi 2===
该仓库里不同的分支代表着Matrix配件所支持的不同开发板。<br>
+
Refer to the following connection diagram to connect the module to the NanoPi M1<br>
* nanopi分支包含了Matrix对NanoPi的支持;
+
[[File:Matrix-Buzzer_nanopi_2.jpg|frameless|600px|Matrix-Buzzer_nanopi_2]]
* tiny4412分支包含了Matrix对Tiny4412的支持;
+
* raspberrypi分支包含了Matrix对RaspberryPi的支持;
+
  
在主机PC上安装git,以Ubuntu14.04为例
+
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-Buzzer || NanoPi 2
 +
|-
 +
|G    || Pin6
 +
|-
 +
|V    || Pin4
 +
|-
 +
|S    || Pin22
 +
|}
 +
 
 +
===Connect to NanoPi M2 / NanoPi 2 Fire===
 +
Refer to the following connection diagram to connect the module to the NanoPi M2/ NanoPi 2 Fire:<br>
 +
[[File:Matrix-Buzzer_nanopi_m2.jpg|frameless|600px|Matrix-Buzzer_nanopi_m2]]
 +
 
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-Buzzer || NanoPi M2
 +
|-
 +
|G    || Pin6
 +
|-
 +
|V    || Pin4
 +
|-
 +
|S    || Pin12
 +
|}
 +
 
 +
===Connect to NanoPC-T2===
 +
Refer to the following connection diagram to connect the module to the NanoPC-T2:<br>
 +
[[File:Matrix-Buzzer_nanopc_t2.jpg|frameless|600px|Matrix-Buzzer_nanopc_t2]]
 +
 
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-Buzzer || NanoPC-T2
 +
|-
 +
|S    || Pin23
 +
|-
 +
|V    || Pin29
 +
|-
 +
|G    || Pin30
 +
|}
 +
 
 +
==Compile & Run Test Program==
 +
Boot your ARM board with Debian and copy the matrix code:
 +
<syntaxhighlight lang="bash">
 +
$ apt-get update && apt-get install git
 +
$ git clone https://github.com/friendlyarm/matrix.git
 +
</syntaxhighlight>
 +
If your cloning is done successfully a "matrix" directory will be generated.
 +
 
 +
Compile and install Matrix:
 +
<syntaxhighlight lang="bash">
 +
$ cd matrix
 +
$ make && make install
 +
</syntaxhighlight>
 +
 
 +
Run test program:
 +
<syntaxhighlight lang="bash">
 +
$ matrix-pwm
 +
</syntaxhighlight>
 +
Note: this module is not plug and play therefore before running the module please make sure it is connected to an ARM board.<br>
 +
Here is what you should observe:<br>
 +
<syntaxhighlight lang="bash">
 +
Using default config: channel=0 freq=1000Hz duty=500
 +
Press enter to stop PWM
 +
</syntaxhighlight>
 +
You can hear the buzzer beeping. The range of the duty cycle  is 0 ~ 1000. When you hit "enter" the buzzer will be stopped.
 +
 
 +
==Code Sample==
 +
This Matrix code sample can work with all the ARM boards mentioned in this module's wiki. The name of this code sample is "matrix-pwm". Here is its source code:
 +
<syntaxhighlight lang="c">
 +
int main(int argc, char ** argv)
 +
{
 +
    int Hz, duty, board;
 +
   
 +
    if ((board = boardInit()) < 0) {
 +
        printf("Fail to init board\n");
 +
        return -1;
 +
    }
 +
   
 +
    system("modprobe "DRIVER_MODULE);
 +
    signal(SIGINT, intHandler);
 +
    if (argc == 4) {
 +
        // Usage:matrix-pwm channel freq duty[0~1000]
 +
        pwm = atoi(argv[1]);
 +
        Hz = atoi(argv[2]);
 +
        duty = atoi(argv[3]);
 +
    } else {
 +
        Hz = 1000;
 +
        duty = 500;
 +
        printf("Using default config: channel=%d freq=%dHz duty=%d\n", pwm, Hz, duty);
 +
    }
 +
    if (PWMPlay(pwm, Hz, duty) == -1) {
 +
        printf("Fail to output PWM\n");
 +
    } 
 +
    printf("Press enter to stop PWM\n");
 +
    getchar();
 +
    PWMStop(pwm);
 +
    system("rmmod "DRIVER_MODULE);
 +
   
 +
    return 0;
 +
}
 +
</syntaxhighlight>
 +
For more details about this APIs called in this code sample refer to [[Matrix API reference manual]] <br>
 +
<!---
 +
==Download Matrix Source Code==
 +
All the matrix modules' code samples are open source. They are maintained on GitHub - https://github.com/friendlyarm/matrix.git <br>
 +
Each branch in this hub contains the matrix modules' code samples for a board that the matrix modules can work with.<br>
 +
* The nanopi branch contains the matrix modules' code samples for the NanoPi
 +
* The nanopi 2 branch contains the matrix modules' code samples for the NanoPi 2
 +
* The tiny4412 branch contains the matrix modules' code samples for the Tiny4412
 +
* The raspberrypi branch contains the matrix modules' code samples for the RaspberryPi
 +
 
 +
Please follow the steps below to get the source code:<br>
 +
Install the git utility on a PC running Ubuntu14.04
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ sudo apt-get install git
 
$ sudo apt-get install git
 
</syntaxhighlight>
 
</syntaxhighlight>
  
克隆Matrix配件代码仓库
+
Clone the matrix code from GitHub
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
$ git clone git://github.com/friendlyarm/matrix.git
+
$ git clone https://github.com/friendlyarm/matrix.git
 
</syntaxhighlight>
 
</syntaxhighlight>
克隆完成后会得到一个matrix目录,里面存放着所有Matrix配件的代码。
+
If this is successful a "matrix" directory will be generated, which will contain all the matrix modules' code samples.
 +
 
 +
==Connect to NanoPi 2==
 +
===Hardware Connection===
 +
Please refer to the following connection diagram to connect the Matrix-Buzzer to the NanoPi 2:<br>
 +
[[File:Matrix-Buzzer_nanopi_2.jpg|frameless|600px|Matrix-Buzzer_nanopi_2]]
 +
 
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-Buzzer || NanoPi 2
 +
|-
 +
|G    || Pin6
 +
|-
 +
|V    || Pin4
 +
|-
 +
|S    || Pin22
 +
|}
 +
 
 +
===Compile Test Program===
 +
Please login the matrix hub and enter the nanopi2 branch
 +
<syntaxhighlight lang="bash">
 +
$ cd matrix
 +
$ git checkout nanopi2
 +
</syntaxhighlight>
 +
 
 +
Compile the matrix code
 +
<syntaxhighlight lang="bash">
 +
$ make CROSS_COMPILE=arm-linux- clean
 +
$ make CROSS_COMPILE=arm-linux-
 +
$ make CROSS_COMPILE=arm-linux- install
 +
</syntaxhighlight>
 +
Note: please make sure to install the cross compiler "arm-linux-gcc-4.9.3" on your PC, which is used to compile files for the NanoPi 2.<br>
 +
Generated library files are under the "install/lib" directory. The test program is under the "install/usr/bin" directory.<br>
 +
The modules are under the "modules" directory. The driver's source code is in github: https://github.com/friendlyarm/linux-3.4.y.git <br>
 +
 
 +
===Run Test Program===
 +
Please insert a TF card which is flashed with Debian to a Linux host and mount its boot and rootfs sections.<br>
 +
We assume the rootfs is mounted to /media/rootfs then please run the following commands to copy the module, library and test program to the card.<br>
 +
<syntaxhighlight lang="bash">
 +
$ cp modules /media/rootfs/ -r
 +
$ cp install/lib/* /media/rootfs/lib/ -d
 +
$ cp install/usr/bin/* /media/rootfs/usr/bin/
 +
</syntaxhighlight>
 +
 
 +
Insert this TF card to your NanoPi 2, power on and run the following commands to load the driver.<br>
 +
<syntaxhighlight lang="bash">
 +
$ cd /modules
 +
$ insmod matrix_pwm.ko
 +
</syntaxhighlight>
 +
 
 +
Start the matrix-buzzer program.<br>
 +
<syntaxhighlight lang="bash">
 +
$ matrix-buzzer
 +
</syntaxhighlight>
 +
 
 +
Here is what you expect to observe:<br>
 +
[[File:matrix-buzzer_result.png|frameless|600px|matrix-buzzer_result]] <br>
 +
You can hear the buzzer beeping. The default PWM frequency is 1KHz and the duty cycle is 50%.
 +
 
 +
===Code Sample===
 +
<syntaxhighlight lang="c">
 +
int main(int argc, char ** argv)
 +
{
 +
    int pin = PWM0;
 +
    int Hz;
 +
    int duty;
 +
   
 +
    if (argc == 4) {
 +
        if (parseCmd(argc, argv, &pin, &Hz, &duty) == -1) {
 +
            return -1;
 +
        }
 +
    } else {
 +
        Hz = 1000;
 +
        duty = 500;
 +
        printf("Usage:%s PWM[0~2] freq duty[0~1000]\n", argv[0]);
 +
        printf("Using default config: pin=PWM0 freq=%dHz duty=%d\n", Hz, duty);
 +
    }
 +
   
 +
    if (PWMPlay(pin, Hz, duty) == -1) {
 +
        printf("Fail to output PWM\n");
 +
    } 
 +
    printf("Press enter to stop PWM\n");
 +
    getchar();
 +
    PWMStop(pin);
 +
    printf("Stopped PWM\n");
 +
    return 0;
 +
}
 +
</syntaxhighlight>
 +
 
  
==与NanoPi连接使用==
+
==Connect to NanoPi==
===准备工作===
+
===Preparations===
在NanoPi上运行Debian系统,然后在主机PC上安装并使用相应的编译器。参考wiki:[[NanoPi/zh|NanoPi]] <br>
+
Please install a Debian on a NanoPi and an appropriate cross compiler on a PC. Please refer to wiki: [[NanoPi/zh|NanoPi]] <br>
注意:必须使用nanopi-v4.1.y-matrix分支编译出来的内核。<br>
+
Compile a NanoPi kernel. Note: please use the kernel's source code from the nanopi-v4.1.y-matrix branch.<br>
下载NanoPi内核源代码并编译
+
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ git clone https://github.com/friendlyarm/linux-4.x.y.git
 
$ git clone https://github.com/friendlyarm/linux-4.x.y.git
Line 58: Line 260:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
===硬件连接===
+
===Hardware Connection===
参考下图连接模块Matrix-Buzzer和NanoPi <br>
+
Please refer to the following connection diagram to connect the Matrix-Buzzer to the NanoPi <br>
 
[[File:matrix-buzzer_nanopi.jpg|frameless|600px|matrix-buzzer_nanopi]]
 
[[File:matrix-buzzer_nanopi.jpg|frameless|600px|matrix-buzzer_nanopi]]
  
连接说明:
+
Connection Details:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 74: Line 276:
 
|}
 
|}
  
===编译测试程序===
+
===Compile Test Program===
进入Matrix代码仓库,切换到nanopi分支
+
Please login the matrix hub and enter the nanopi branch
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ cd matrix
 
$ cd matrix
Line 81: Line 283:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
编译Matrix配件代码
+
Compile the matrix code
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ make CROSS_COMPILE=arm-linux- clean
 
$ make CROSS_COMPILE=arm-linux- clean
Line 87: Line 289:
 
$ make CROSS_COMPILE=arm-linux- install
 
$ make CROSS_COMPILE=arm-linux- install
 
</syntaxhighlight>
 
</syntaxhighlight>
注意:请确保你的主机PC当前使用的交叉编译器为NanoPi-Debian配套的arm-linux-gcc-4.4.3。<br>
+
Note: please make sure to install the cross compiler "arm-linux-gcc-4.4.3" on your PC, which is used to compile files for the NanoPi-Debian.<br>
编译出来的库文件位于install/lib目录下,而测试程序则位于install/usr/bin目录下,模块Matrix-Buzzer对应的测试程序为matrix-buzzer。<br>
+
Generated library files are under the "install/lib" directory. Applications are under the "install/usr/bin" directory. The test program for the "Matrix-Buzzer" module is "matrix-buzzer".<br>
  
===运行测试程序===
+
===Run Test Program===
拷贝库文件和测试程序到NanoPi的文件系统上
+
Please copy the library files and test program to the NanoPi
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ cp install/usr/bin/* nanopi_rootfs/usr/bin/
 
$ cp install/usr/bin/* nanopi_rootfs/usr/bin/
Line 97: Line 299:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
然后启动NanoPi,在Debian的shell终端中执行如下命令运行模块Matrix-Buzzer的测试程序 <br>
+
Power on the NanoPi and run the following command in Debian's terminal <br>
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ matrix-buzzer
 
$ matrix-buzzer
 
</syntaxhighlight>
 
</syntaxhighlight>
  
===代码展示===
+
===Code Sample===
 
<syntaxhighlight lang="c">
 
<syntaxhighlight lang="c">
 
int main(int argc, char ** argv)
 
int main(int argc, char ** argv)
Line 133: Line 335:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==与Tiny4412连接使用==
+
==Connect to Tiny4412==
===准备工作===
+
===Preparations===
参考Tiny4412光盘里的《友善之臂Ubuntu使用手册》,在Tiny4412上运行UbuntuCore系统,然后在主机PC上安装并使用相应的编译器。<br>
+
Please refer to the Tiny4412's user's manual to install a UbuntuCore on the Tiny4412 and install an appropriate cross compiler on a PC.<br>
注意:只能使用Tiny4412SDK-1506的底板。
+
Note: only the Tiny4412SDK-1506 carrier board can work with this module.
  
===硬件连接===
+
===Hardware Connection===
参考下图连接模块Matrix-Buzzer和Tiny4412 <br>
+
Please refer to the following diagram to connect the Matrix-Buzzer to the Tiny4412 <br>
 
[[File:matrix-buzzer_tiny4412.jpg|frameless|600px|matrix-buzzer_tiny4412]]
 
[[File:matrix-buzzer_tiny4412.jpg|frameless|600px|matrix-buzzer_tiny4412]]
  
连接说明:
+
Connection Details:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 154: Line 356:
 
|}
 
|}
  
===编译测试程序===
+
===Compile Test Program===
进入Matrix代码仓库,切换到tiny4412分支
+
Please login the Matrix hub and enter the matrix-tiny4412 branch
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ cd matrix
 
$ cd matrix
Line 161: Line 363:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
编译Matrix配件代码
+
Compile the matrix code
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ make CROSS_COMPILE=arm-linux-gnueabihf- clean
 
$ make CROSS_COMPILE=arm-linux-gnueabihf- clean
Line 167: Line 369:
 
$ make CROSS_COMPILE=arm-linux-gnueabihf- install
 
$ make CROSS_COMPILE=arm-linux-gnueabihf- install
 
</syntaxhighlight>
 
</syntaxhighlight>
注意:请确保你的主机PC当前使用的交叉编译器为Tiny4412-UbuntuCore配套的arm-linux-gnueabihf-gcc-4.7.3。<br>
+
Note: please make sure to install the cross compiler "arm-linux-gnueabihf-gcc-4.7.3" on your PC, which is used to compile files for the Tiny4412-UbuntuCore. <br>
编译出来的库文件位于install/lib目录下,而测试程序则位于install/usr/bin目录下,模块Matrix-Buzzer对应的测试程序为matrix-buzzer。
+
Generated library files are under the "install/lib" directory. Applications are under the "install/usr/bin" directory. The test program for the "Matrix-Buzzer" module is "matrix-buzzer".
  
===运行测试程序===
+
===Run Test Program===
拷贝库文件和测试程序到Tiny4412的UbuntuCore的文件系统上
+
Please copy the library files and test program to the Tiny4412
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ cp install/usr/bin/* tiny4412_rootfs/usr/bin/
 
$ cp install/usr/bin/* tiny4412_rootfs/usr/bin/
Line 177: Line 379:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
然后启动Tiny4412,在UbuntuCore的shell终端中执行如下命令运行模块Matrix-Buzzer的测试程序
+
Power on the Tiny4412 and run the following command in UbuntuCore's terminal
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ matrix-buzzer
 
$ matrix-buzzer
 
</syntaxhighlight>
 
</syntaxhighlight>
  
===代码展示===
+
===Code Sample===
 
<syntaxhighlight lang="c">
 
<syntaxhighlight lang="c">
 
int main(int argc, char ** argv)
 
int main(int argc, char ** argv)
Line 213: Line 415:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==与RaspberryPi连接使用==
+
==Connect to RaspberryPi==
  
==与Arduino连接使用==
+
==Connect to Arduino==
 +
--->
  
==相关资料==
+
==Resources==
  
 +
==Update Log==
 +
===Feb-23-2016===
 +
* Added the description for "NanoPi 2 branch" in Section 4
 +
* Added Section 5: Connect to NanoPi 2
 +
===June-17-2016===
 +
* Re-organized and simplified wiki
  
 
<!--
 
<!--

Latest revision as of 10:32, 19 June 2016

查看中文

1 Introduction

Buzzer
  • The Matrix-Buzzer is a passive buzzer. To drive this buzzer an oscillating source generating 2K - 5K square waves is needed.
  • It can be used in electronic devices that need sound generators.

2 Features

  • 3 PIN interface
  • PCB dimension (mm): 16 x 24

Buzzer PCB

  • Pin Description:
Pin Description
V Supply Voltage 5V
G Ground
S PWM Input

3 Basic Device Operation

A passive buzzer will not tweet if DC signals are used; instead, you need to use square waves whose frequency is between 2K and 5K to drive it. If you use GPIO signals to drive it you need to pull the GPIO high first and then low to generate oscillation. The oscillation frequency is generated by the time in which GPIO signals turn from high to low. The buzzer will generate different sounds based on different frequencies.

4 Applications

4.1 Connect to NanoPi 2

Refer to the following connection diagram to connect the module to the NanoPi M1
Matrix-Buzzer_nanopi_2

Connection Details:

Matrix-Buzzer NanoPi 2
G Pin6
V Pin4
S Pin22

4.2 Connect to NanoPi M2 / NanoPi 2 Fire

Refer to the following connection diagram to connect the module to the NanoPi M2/ NanoPi 2 Fire:
Matrix-Buzzer_nanopi_m2

Connection Details:

Matrix-Buzzer NanoPi M2
G Pin6
V Pin4
S Pin12

4.3 Connect to NanoPC-T2

Refer to the following connection diagram to connect the module to the NanoPC-T2:
Matrix-Buzzer_nanopc_t2

Connection Details:

Matrix-Buzzer NanoPC-T2
S Pin23
V Pin29
G Pin30

5 Compile & Run Test Program

Boot your ARM board with Debian and copy the matrix code:

$ apt-get update && apt-get install git
$ git clone https://github.com/friendlyarm/matrix.git

If your cloning is done successfully a "matrix" directory will be generated.

Compile and install Matrix:

$ cd matrix
$ make && make install

Run test program:

$ matrix-pwm

Note: this module is not plug and play therefore before running the module please make sure it is connected to an ARM board.
Here is what you should observe:

Using default config: channel=0 freq=1000Hz duty=500
Press enter to stop PWM

You can hear the buzzer beeping. The range of the duty cycle is 0 ~ 1000. When you hit "enter" the buzzer will be stopped.

6 Code Sample

This Matrix code sample can work with all the ARM boards mentioned in this module's wiki. The name of this code sample is "matrix-pwm". Here is its source code:

int main(int argc, char ** argv)
{
    int Hz, duty, board;
 
    if ((board = boardInit()) < 0) {
        printf("Fail to init board\n");
        return -1;
    } 
 
    system("modprobe "DRIVER_MODULE);
    signal(SIGINT, intHandler);
    if (argc == 4) {
        // Usage:matrix-pwm channel freq duty[0~1000]
        pwm = atoi(argv[1]);
        Hz = atoi(argv[2]);
        duty = atoi(argv[3]);
    } else {
        Hz = 1000;
        duty = 500;
        printf("Using default config: channel=%d freq=%dHz duty=%d\n", pwm, Hz, duty);
    }
    if (PWMPlay(pwm, Hz, duty) == -1) {
        printf("Fail to output PWM\n");
    }  
    printf("Press enter to stop PWM\n");
    getchar();
    PWMStop(pwm);
    system("rmmod "DRIVER_MODULE);
 
    return 0;
}

For more details about this APIs called in this code sample refer to Matrix API reference manual

7 Resources

8 Update Log

8.1 Feb-23-2016

  • Added the description for "NanoPi 2 branch" in Section 4
  • Added Section 5: Connect to NanoPi 2

8.2 June-17-2016

  • Re-organized and simplified wiki