Difference between revisions of "Matrix - Buzzer"

From FriendlyARM WiKi
Jump to: navigation, search
(介绍)
(Applications)
 
(34 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[Matrix - Buzzer/zh|查看中文]]
 
[[Matrix - Buzzer/zh|查看中文]]
  
==介绍==
+
==Introduction==
[[File:pwm.jpg|thumb|Buzzer]]
+
[[File:Buzzer.jpg|thumb|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.
  
==特性==
+
==Features==
待写...
+
* 3 PIN interface
 +
* PCB dimension (mm): 16 x 24
 +
[[File:buzzerpcb.png|frameless|400px|Buzzer PCB]]
  
==使用方法==
+
* Pin Description:
===连接===
+
{| class="wikitable"
*连接到Tiny4412 SDK (1506)
+
|-
::首先,你需要去掉Tiny4412 SDK 1506底板上面的BP1_EN的跳线帽
+
|Pin || Description
::然后,将配件S针脚连接到GPIO PIN1, V接5V,G接地
+
|-
 +
|V    || Supply Voltage 5V
 +
|-
 +
|G    || Ground
 +
|-
 +
|S      || PWM Input
 +
|}
  
===Linux下的C示例===
+
==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.
 +
 
 +
==Applications==
 +
===Connect to NanoPi 2===
 +
Refer to the following connection diagram to connect the module to the NanoPi M1<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
 +
|}
 +
 
 +
===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">
 +
$ sudo apt-get install git
 +
</syntaxhighlight>
 +
 
 +
Clone the matrix code from GitHub
 +
<syntaxhighlight lang="bash">
 +
$ git clone https://github.com/friendlyarm/matrix.git
 +
</syntaxhighlight>
 +
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>
 +
 
 +
 
 +
==Connect to NanoPi==
 +
===Preparations===
 +
Please install a Debian on a NanoPi and an appropriate cross compiler on a PC. Please refer to wiki: [[NanoPi/zh|NanoPi]] <br>
 +
Compile a NanoPi kernel. Note: please use the kernel's source code from the nanopi-v4.1.y-matrix branch.<br>
 +
<syntaxhighlight lang="bash">
 +
$ git clone https://github.com/friendlyarm/linux-4.x.y.git
 +
$ cd linux-4.x.y
 +
$ git checkout nanopi-v4.1.y-matrix
 +
$ make nanopi_defconfig
 +
$ touch .scmversion
 +
$ make
 +
</syntaxhighlight>
 +
 
 +
===Hardware Connection===
 +
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]]
 +
 
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-Buzzer || NanoPi     
 +
|-
 +
|G    || Pin6
 +
|-
 +
|V    || Pin4
 +
|-
 +
|S      || Pin22
 +
|}
 +
 
 +
===Compile Test Program===
 +
Please login the matrix hub and enter the nanopi branch
 +
<syntaxhighlight lang="bash">
 +
$ cd matrix
 +
$ git checkout nanopi
 +
</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.4.3" on your PC, which is used to compile files for the NanoPi-Debian.<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===
 +
Please copy the library files and test program to the NanoPi
 +
<syntaxhighlight lang="bash">
 +
$ cp install/usr/bin/* nanopi_rootfs/usr/bin/
 +
$ cp install/lib/* nanopi_rootfs/lib/ -d
 +
</syntaxhighlight>
 +
 
 +
Power on the NanoPi and run the following command in Debian's terminal <br>
 +
<syntaxhighlight lang="bash">
 +
$ matrix-buzzer
 +
</syntaxhighlight>
 +
 
 +
===Code Sample===
 +
<syntaxhighlight lang="c">
 +
int main(int argc, char ** argv)
 +
{
 +
    int pin = PWM_PIN1;
 +
    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~1] 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>
 +
 
 +
==Connect to Tiny4412==
 +
===Preparations===
 +
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>
 +
Note: only the Tiny4412SDK-1506 carrier board can work with this module.
 +
 
 +
===Hardware Connection===
 +
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]]
 +
 
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-Buzzer || Tiny4412
 +
|-
 +
|G    || GPIO1 GND
 +
|-
 +
|V    || GPIO1 5V
 +
|-
 +
|S      || GPIO11 S
 +
|}
 +
 
 +
===Compile Test Program===
 +
Please login the Matrix hub and enter the matrix-tiny4412 branch
 +
<syntaxhighlight lang="bash">
 +
$ cd matrix
 +
$ git checkout tiny4412
 +
</syntaxhighlight>
 +
 
 +
Compile the matrix code
 +
<syntaxhighlight lang="bash">
 +
$ make CROSS_COMPILE=arm-linux-gnueabihf- clean
 +
$ make CROSS_COMPILE=arm-linux-gnueabihf-
 +
$ make CROSS_COMPILE=arm-linux-gnueabihf- install
 +
</syntaxhighlight>
 +
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>
 +
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===
 +
Please copy the library files and test program to the Tiny4412
 +
<syntaxhighlight lang="bash">
 +
$ cp install/usr/bin/* tiny4412_rootfs/usr/bin/
 +
$ cp install/lib/* tiny4412_rootfs/lib/ -d
 +
</syntaxhighlight>
 +
 
 +
Power on the Tiny4412 and run the following command in UbuntuCore's terminal
 +
<syntaxhighlight lang="bash">
 +
$ matrix-buzzer
 +
</syntaxhighlight>
 +
 
 +
===Code Sample===
 +
<syntaxhighlight lang="c">
 +
int main(int argc, char ** argv)
 +
{
 +
    int pin = PWM_PIN1;
 +
    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~1] 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>
 +
 
 +
==Connect to RaspberryPi==
 +
 
 +
==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
 +
 
 +
<!--
 +
 
 +
==Introduction==
 +
[[File:Buzzer.jpg|thumb|Buzzer]]
 +
We utilize a 5V passive buzzer. To drive this buzzer an oscillating source is needed. Pin V is power, Pin G is grounded and Pin S is PMW signal input. Pin S is connected to a triode to turn on/off the buzzer. A PWM signal can be either 3.3V or 5V and the buzzer's sound will vary accordingly.
 +
 
 +
==Features==
 +
* 5V Power Supply
 +
* 3.3V/5V PWM
 +
* Tiny, easy to be used in various situations
 +
* 2.54mm spacing pin
 +
 
 +
==How To==
 +
===Connection===
 +
<div id="Tiny4412"></div>
 +
*Connect to Tiny4412 SDK (1506)
 +
::Firstly you need to remove the jumper on BP1_EN on the Tiny4412 SDK 1506 carrier board
 +
::Please connect Pin S to GPIO PIN1, V to 5V and G grounded
 +
<div id="NanoPi"></div>
 +
*Connect to NanoPi
 +
::TODO
 +
 
 +
===Code Sample in C Under Linux===
 
<syntaxhighlight lang="c">
 
<syntaxhighlight lang="c">
 
#include <stdio.h>
 
#include <stdio.h>
Line 79: Line 516:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
===编译并运行示例===
+
===Compile and Run===
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
git clone http://github.com/friendlyarm/fa-hardware.git
 
git clone http://github.com/friendlyarm/fa-hardware.git
 
cd fa-hardware
 
cd fa-hardware
 
cd demo
 
cd demo
cd buzzer
+
cd matrix-buzzer
 
make
 
make
 
</syntaxhighlight>
 
</syntaxhighlight>
将编译生成的buzzer通过ftp上传到开发板上运行即可测试。
+
Copy your compiled bin to your board and you are ready to go.
 +
 
 +
==Resources==
  
==相关资料==
+
-->

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