1. はじめに

「Lチカで始めるテスト自動化(18)秋月のIoT学習HATキットの圧電ブザーでテスト終了時にpass/failに応じてメロディを流す」で作成したメロディを鳴らすプログラムをWindowsに移植します。

2. Windows版Pythonでビープ音を鳴らす

winsound.Beep(frequency, duration)を使用します。

frequencyの単位はHzで37～32,767の範囲です。
- Pythonのソースコードのwinsound.cを調べたところ周波数の下限、上限とも直値で記述されており、下限、上限のマクロは特に無いようです。
durationの単位はミリ秒です。

3. ソースコード

WindowsとRaspberry Pi Zeroで共用できるようwin32かそうでないかで機種判定を行っています。
IoT学習HATキットの圧電ブザー向けに作成した楽譜は周波数を500Hz程度に抑えていてWindows PCで再生してもあまりよく聞こえなかったため周波数を4倍しています。倍率はお使いの機種に合わせて調整してください。

beepsound.py

# -*- coding: utf-8 -*-
# beepsound.py
# python 3.x
#
# beepsound for Akizuki IoT Learning HAT on Raspberry Pi Zero and Windows
#
# This software includes the work that is distributed
# in the Apache License 2.0
# ka's@pbjpkas 2022
#

import sys
from time import sleep

# Akizuki IoT Learning HAT GPIO Number
BUZZER_PIN = 23 #PIN16, GPIO23

#Note, Frequency
R   =   0 #rest
C3  = 131
CS3 = 139
D3  = 147
DS3 = 156
E3  = 165
F3  = 175
FS3 = 185
G3  = 196
GS3 = 208
A3  = 220
AS3 = 233
B3  = 247
C4  = 262
CS4 = 277
D4  = 294
DS4 = 311
E4  = 330
F4  = 349
FS4 = 370
G4  = 392
GS4 = 415
A4  = 440
AS4 = 466
B4  = 494
C5  = 523

class BEEPSOUND:
    def __init__(self, tempo=120.0):
        if sys.platform == "win32":
            pass
        else: #Akizuki IoT Learning HAT on Raspberry Pi Zero
            import RPi.GPIO as GPIO
            import wiringpi
            GPIO.setwarnings(False)
            GPIO.setmode(GPIO.BCM)
            GPIO.setup(BUZZER_PIN, GPIO.OUT)
            wiringpi.wiringPiSetupGpio()
            wiringpi.softToneCreate(BUZZER_PIN)

        self.tempo = tempo

    def set_tempo(self, tempo):
        self.tempo = float(tempo)

    def generate(self, note, length):
        if float(length) != 0:
            duration = float( (4/float(length)) * (60.0/self.tempo) )
            if sys.platform == "win32":
                import winsound
                if (note<37) or (note>32767):
                    sleep(duration)
                else:
                    winsound.Beep(note*4, int(duration*1000))
            else:
                import wiringpi
                if (note<0) or (note>5000):
                    sleep(duration)
                else:
                    wiringpi.softToneWrite(BUZZER_PIN, int(note))
                    sleep(duration*0.95)
                    wiringpi.softToneWrite(BUZZER_PIN, 0)
                    sleep(duration*0.05)

    # Für Elise - Ludwig van Beethoven
    # https://ja.wikipedia.org/wiki/エリーゼのために
    def FurElise(self):
        self.generate(E4, 16)
        self.generate(DS4,16)
        
        self.generate(E4, 16)
        self.generate(DS4,16)
        self.generate(E4, 16)
        self.generate(B3, 16)
        self.generate(D4, 16)
        self.generate(C4, 16)
        
        self.generate(A3,  8)
        self.generate(R,  16)
        self.generate(C3, 24)
        self.generate(E3, 24)
        self.generate(A3, 24)
        
        self.generate(B3,  8)
        self.generate(R,  16)
        self.generate(E3, 24)
        self.generate(GS3,24)
        self.generate(B3, 24)
        
        self.generate(C4,  8)
        self.generate(R,  16)

    # Menuet - Christian Petzold
    # https://ja.wikipedia.org/wiki/メヌエット (ペツォールト)
    def Menuet(self):
        self.generate(D4,  4)
        self.generate(G3,  8)
        self.generate(A3,  8)
        self.generate(B3,  8)
        self.generate(C4,  8)
        self.generate(D4,  4)
        self.generate(G3,  4)
        self.generate(G3,  4)
        
        self.generate(E4,  4)
        self.generate(C4,  8)
        self.generate(D4,  8)
        self.generate(E4,  8)
        self.generate(FS4, 8)
        self.generate(G4,  4)
        self.generate(G3,  4)
        self.generate(G3,  4)

    # Toccata und Fuge in d-Moll BWV565 - Johann Sebastian Bach
    # https://www.gmajormusictheory.org/Freebies/Level2/2ToccataFugueDm/2ToccataFugueDm.pdf
    def ToccataUndFugeInDMoll(self):
        self.generate(A4, 16)
        self.generate(G4, 16)
        #self.generate(A4,  8)
        self.generate(A4,  2)
        self.generate(G4, 16)
        self.generate(F4, 16)
        self.generate(E4, 16)
        self.generate(D4, 16)
        self.generate(CS4, 4)
        self.generate(D4,  2)
        self.generate(R ,  4)

if __name__ == '__main__':
    beepsound = BEEPSOUND()
    beepsound.set_tempo(60)
    beepsound.FurElise()
    
    beepsound.set_tempo(120)
    beepsound.Menuet()
    beepsound.ToccataUndFugeInDMoll()

4. テストランナーの改修

テストランナーへ以下の改修を行います。

beepsound.pyをimportする
BEEPSOUND()を実行してインスタンスを生成する
楽譜データのデバッグのためにbeepsoundコマンドを追加する
failして終了する箇所に「エリーゼのために」を追記する
passして終了する箇所に「メヌエット」を追記する

「Lチカで始めるテスト自動化(24)コマンドの実行結果を任意のCSVファイルへ出力する」の付録A. ソースコード全文との差分を以下に示します。ソース全文は付録Aをご覧ください。

diff

30a31
> from beepsound import BEEPSOUND
188a190
>     beepsound = BEEPSOUND()
368a371,383
>                 elif cmd[0] == "beepsound":
>                     if cmd[1] == "FurElise":
>                         beepsound.set_tempo(60)
>                         beepsound.FurElise()
>                     elif cmd[1] == "Menuet":
>                         beepsound.set_tempo(120)
>                         beepsound.Menuet()
>                     elif cmd[1] == "ToccataUndFugeInDMoll":
>                         beepsound.set_tempo(120)
>                         beepsound.ToccataUndFugeInDMoll()
>                     else:
>                         is_passed = False
>
475a491,492
>                     beepsound.set_tempo(60)
>                     beepsound.FurElise()
484a502,503
>         beepsound.set_tempo(120)
>         beepsound.Menuet()

5. おわりに

Windowsでもテスト終了時にメロディを再生できるようになりました。

付録A. テストランナーのソースコード全文

importしているcamera.pyはこちらです。

test-runner.py

#!/usr/bin/python3

#
# This software includes the work that is distributed
# in the Apache License 2.0
#

from time import sleep
import random
import sys
import codecs
import csv
import datetime
import serial
import pyvisa as visa

#【Python】opencvでWebカメラの起動に時間がかかる問題の対処
# https://qiita.com/youichi_io/items/b894b85d790720ea2346
import os
os.environ["OPENCV_VIDEOIO_MSMF_ENABLE_HW_TRANSFORMS"] = "0"
import cv2

from PIL import Image
import pyocr
import pyocr.builders
import platform
import subprocess
from subprocess import PIPE
import threading
from camera import Camera
from beepsound import BEEPSOUND

UNINITIALIZED = 0xdeadbeef
NUM_OF_SERVO = 6

def serial_write(h, string):
    if h != UNINITIALIZED:
        string = string + '\n'
        string = str.encode(string)
        h.write(string)
        return True
    else:
        print("UART Not Initialized.")
        return False

def close_uart(h):
    if h != UNINITIALIZED:
        h.close()
    else:
        #print("UART Not Initialized.")
        pass

def open_dso():
    rm = visa.ResourceManager()
    resources = rm.list_resources()
    #print(resources)
    for resource in resources:
        #print(resource)
        try:
            dso = rm.open_resource(resource)
        except:
            print(resource, "Not Found.")
        else:
            print(resource, "Detected.")
            return dso

    #Throw an error to caller if none succeed.
    return dso

def crop_img(filename_in, v, h, filename_out):
    img = cv2.imread(filename_in, cv2.IMREAD_COLOR)
    v0 = int(v.split(':')[0])
    v1 = int(v.split(':')[1])
    h0 = int(h.split(':')[0])
    h1 = int(h.split(':')[1])
    img2 = img[v0:v1, h0:h1]
    cv2.imwrite(filename_out, img2)
    return True

def open_ocr():
    ocr = pyocr.get_available_tools()
    if len(ocr) != 0:
        ocr = ocr[0]
    else:
        ocr = UNINITIALIZED
        print("OCR Not Ready.")
    return ocr

def exec_ocr(ocr, filename):
    try:
        txt = ocr.image_to_string(
            Image.open(filename),
            lang = "eng",
            builder = pyocr.builders.TextBuilder()
        )
    except:
        print("OCR Fail.")
    else:
        return txt

def exec_labelimg(filename, label_string):
    if platform.system() == "Windows" :
        python = "python"
        grep = "findstr"
    else:
        python = "python3"
        grep = "grep"

    cmd = python + \
          " label_image.py \
          --graph=c:\\tmp\\output_graph.pb \
          --labels=c:\\tmp\\output_labels.txt \
          --input_layer=Placeholder \
          --output_layer=final_result \
          --image=" + filename \
          + "|" + grep + " " + label_string
    print(cmd)
    log = subprocess.run(cmd, stdout=subprocess.PIPE, shell=True)
    ret = log.stdout.strip().decode("utf-8").split(" ")[1]
    return ret

def set_servo(uart, servo_id, servo_pos):
    if servo_id < 0 or servo_id >= NUM_OF_SERVO:
        print("Invalid Servo ID")
        return False

    if servo_pos < 0 or servo_pos > 180:
        print("Invalid Servo Position")
        return False

    if uart != UNINITIALIZED:
        serial_write(uart, "servoread")

        servo_position = uart.readline().strip().decode('utf-8')
        print(servo_position)

        # discard "OK"
        devnull = uart.readline().strip().decode('utf-8')

        current_pos = int(servo_position.split(' ')[servo_id])
        #print(servo_id, current_pos)

        if current_pos < servo_pos:
            start = current_pos +1
            stop  = servo_pos +1
            step  = 1
        else:
            start = current_pos -1
            stop  = servo_pos -1
            step  = -1

        for i in range(start, stop, step):
            command = "servo " + str(servo_id) + " " + str(i)
            print(command)
            serial_write(uart, command)
            # discard "OK"
            devnull = uart.readline().strip().decode('utf-8')
            sleep(0.2) # sec.

        return True
    else:
        print("UART Not Initialized.")
        return False

def device_close(uart, cam):
    close_uart(uart)

    for i in range(len(cam)):
        if cam[i].get_video_rec() == True:
            cam[i].set_video_rec(False)
            cam[i].thread.join()
        else:
            pass
            #print("No Recording.")
        cam[i].close_cam()

def main():
    is_passed = True
    val = str(UNINITIALIZED)
    fval = 0.0
    uart = UNINITIALIZED
    dso = UNINITIALIZED
    cam = UNINITIALIZED
    ocr = UNINITIALIZED
    cmds = ""
    cam0 = Camera(0)
    cam1 = Camera(1)
    cam2 = Camera(2)
    cam  = [cam0, cam1, cam2]
    beepsound = BEEPSOUND()

    #exportfiles
    #概要
    #  exportコマンドで使用するN行3列の二次元配列
    #説明
    #  以下の3つの要素を1行3桁の配列で構造化し、
    #    1.ファイルオブジェクト(open()の戻り値)
    #    2.Writerオブジェクト(csv.writer()の戻り値)
    #    3.ファイルに出力するデータのバッファ
    #  出力するファイルの数だけこの配列を行方向に追加する
    #構造
    #  exportfiles = [ 
    #                 [ [FileObject],[WriterObject],[Buffer] ], #1つめの出力ファイルの配列
    #                 [ [FileObject],[WriterObject],[Buffer] ], #2つめの出力ファイルの配列
    #                 ...
    #                ]
    #初期値
    #  空の1行3列の2次元配列で初期化する
    exportfiles = [\
                   [ [],[],[] ]\
                  ]

    if len(sys.argv) == 2:
        script_file_name = sys.argv[1] + ".csv"
        result_file_name = sys.argv[1] + "_result.csv"
    else:
        script_file_name = "script.csv"
        result_file_name = "result.csv"

    with codecs.open(script_file_name, 'r', 'utf-8') as file_script:
        script = csv.reader(file_script, delimiter=',', lineterminator='\r\n', quotechar='"')

        with codecs.open(result_file_name, 'w', 'utf-8') as file_result:
            result = csv.writer(file_result, delimiter=',', lineterminator='\r\n', quotechar='"')

            script_line = 0
            for cmd in script:
                timestamp = datetime.datetime.now().strftime("%Y/%m/%d %H:%M:%S")
                script_line += 1
                print("##### " + timestamp + " " + str(script_line) + " #####")

                cmds = str(script_line) + ":"
                for i in range(len(cmd)):
                    cmds += cmd[i] + ","
                for i in range(len(cam)):
                    cam[i].set_video_txt(cmds)
                print(cmds)

                if "#" in cmd[0]:
                    pass

                elif cmd[0] == "sleep":
                    sleep(float(cmd[1]))

                elif cmd[0] == "rusleep":
                    fval = random.uniform(float(cmd[1]), float(cmd[2]))
                    val = str(fval)
                    cmd.append(val)
                    cmds += val
                    for i in range(len(cam)):
                        cam[i].set_video_txt(cmds)
                    print(cmds)
                    sleep(fval)

                elif cmd[0] == "prompt":
                    print("Enter y/n")
                    val = input()
                    val = val.lower()
                    cmd.append(val)
                    cmds += val
                    for i in range(len(cam)):
                        cam[i].set_video_txt(cmds)
                    print(cmds)
                    sleep(1)
                    if val != "y":
                        is_passed = False

                elif cmd[0] == "open_uart":
                    if len(cmd) == 2:
                        dsrdtr_val = 1
                    else:
                        dsrdtr_val = int(cmd[2])
                    try:
                        uart = serial.Serial(cmd[1], 115200, timeout=1.0, dsrdtr=dsrdtr_val)
                    except:
                        is_passed = False

                elif cmd[0] == "send":
                    ret = serial_write(uart, cmd[1])
                    if ret == False:
                        is_passed = False

                elif cmd[0] == "rcvd":
                    try:
                        val = uart.readline().strip().decode('utf-8')
                        cmd.append(val)
                    except:
                        is_passed = False

                elif cmd[0] == "open_dso":
                    try:
                        dso = open_dso()
                    except:
                        is_passed = False

                elif cmd[0] == "dso":
                    try:
                        if "?" in cmd[1]:
                            val = dso.query(cmd[1]).rstrip().replace(",", "-")
                            cmd.append(val)
                        else:
                            dso.write(cmd[1])
                    except:
                        is_passed = False

                elif cmd[0] == "open_cam":
                    if len(cmd) == 2:
                        cam[int(cmd[1])].open_cam(640, 480)
                    else:
                        cam[int(cmd[1])].open_cam(int(cmd[2]), int(cmd[3]))

                elif cmd[0] == "close_cam":
                    cam[int(cmd[1])].close_cam()

                elif cmd[0] == "capture_cam":
                    ret = cam[int(cmd[1])].capture_cam(cmd[2])
                    if ret == False:
                        is_passed = False

                elif cmd[0] == "rec_start":
                    if cam[int(cmd[1])].get_video_rec() == False:
                        cam[int(cmd[1])].set_video_rec(True)
                        cam[int(cmd[1])].thread = threading.Thread(target=cam[int(cmd[1])].video_record, args=(cmd[2],))
                        cam[int(cmd[1])].thread.start()
                    else:
                        print("Already Recording.")

                elif cmd[0] == "rec_stop":
                    if cam[int(cmd[1])].get_video_rec() == True:
                        cam[int(cmd[1])].set_video_rec(False)
                        cam[int(cmd[1])].thread.join()
                    else:
                        print("No Recording.")

                elif cmd[0] == "crop_img":
                    crop_img(cmd[1], cmd[2], cmd[3], cmd[4])

                elif cmd[0] == "open_ocr":
                    ocr = open_ocr()
                    if ocr == UNINITIALIZED:
                        is_passed = False

                elif cmd[0] == "exec_ocr":
                    try:
                        val = exec_ocr(ocr, cmd[1])
                    except:
                        is_passed = False
                    else:
                        cmd.append(str(val))

                elif cmd[0] == "exec_labelimg":
                    try:
                        val = exec_labelimg(cmd[1], cmd[2])
                    except:
                        is_passed = False
                    else:
                        cmd.append(str(val))

                elif cmd[0] == "set_servo":
                    ret = set_servo(uart, int(cmd[1]), int(cmd[2]))
                    if ret == False:
                        is_passed = False

                elif cmd[0] == "run":
                    ret = subprocess.run(cmd[1], shell=True, stdout=PIPE, stderr=PIPE, universal_newlines=True)
                    val = ret.stdout.strip()
                    print(ret)
                    if ret.returncode != 0:
                        is_passed = False

                elif cmd[0] == "beepsound":
                    if cmd[1] == "FurElise":
                        beepsound.set_tempo(60)
                        beepsound.FurElise()
                    elif cmd[1] == "Menuet":
                        beepsound.set_tempo(120)
                        beepsound.Menuet()
                    elif cmd[1] == "ToccataUndFugeInDMoll":
                        beepsound.set_tempo(120)
                        beepsound.ToccataUndFugeInDMoll()
                    else:
                        is_passed = False

                elif cmd[0] == "eval_str_eq":
                    if str(val) != str(cmd[1]):
                        is_passed = False

                elif cmd[0] == "eval_int_eq":
                    if int(val) != int(cmd[1]):
                        is_passed = False

                elif cmd[0] == "eval_int_gt":
                    if int(val) < int(cmd[1]):
                        is_passed = False

                elif cmd[0] == "eval_int_lt":
                    if int(val) > int(cmd[1]):
                        is_passed = False

                elif cmd[0] == "eval_dbl_eq":
                    if float(val) != float(cmd[1]):
                        is_passed = False

                elif cmd[0] == "eval_dbl_gt":
                    if float(val) < float(cmd[1]):
                        is_passed = False

                elif cmd[0] == "eval_dbl_lt":
                    if float(val) > float(cmd[1]):
                        is_passed = False

                #export,<filename.csv>,str,<string>
                #export,<filename.csv>,linenumber
                #export,<filename.csv>,timestamp
                #export,<filename.csv>,val
                #export,<filename.csv>,writerow
                elif cmd[0] == "export":
                    #1)引数が3以上の場合に処理を行う
                    if len(cmd) >= 3:
                        #2)操作対象のファイルディスクリプタを決める
                        ##2.1)操作対象のファイルディスクリプタを検索する
                        exportfile = None
                        i = 0 #exportfiles配列の行番号
#                        print(exportfiles)
                        for f in exportfiles:
                            if f[0]:
#                                print(f[0].name)
                                if f[0].name == cmd[1]:
                                    exportfile = f
                                    break
                                i = i + 1

#                        print("index " + str(i))

                        ##2.2)操作対象のファイルディスクリプタがない場合は自動でopenする
                        if exportfile == None:
                            if i >= 1:
                                exportfiles.append([[],[],[]])
                            exportfiles[i][0] = codecs.open(cmd[1], 'w', 'utf-8')
                            exportfiles[i][1] = csv.writer(exportfiles[i][0], delimiter=',', lineterminator='\r\n', quotechar='"')
#                            print(i, exportfiles)

                        if cmd[2] == "str":
#                            print("str  " + exportfiles[i][0].name)
                            exportfiles[i][2].append(cmd[3])

                        elif cmd[2] == "linenumber":
#                            print("line " + exportfiles[i][0].name)
                            exportfiles[i][2].append(str(script_line))

                        elif cmd[2] == "timestamp":
#                            print("time " + exportfiles[i][0].name)
                            exportfiles[i][2].append(timestamp)

                        elif cmd[2] == "val":
#                            print("val  " + exportfiles[i][0].name)
                            exportfiles[i][2].append(str(val))

                        elif cmd[2] == "writerow":
#                            print("wrow " + exportfiles[i][0].name)
#                            print(exportfiles)
                            exportfiles[i][1].writerow(exportfiles[i][2])
                            exportfiles[i][2].clear()

                        else:
                            print("export parameter error")
                            is_passed = False

                    else:
                        print("export parameter error")
                        is_passed = False

                else:
                    cmd.append("#")

                if is_passed == True:
                    cmd.append("OK")
                    cmd.insert(0,timestamp)
                    print(cmd)
                    result.writerow(cmd)
                else:
                    cmd.append("NG")
                    cmd.insert(0,timestamp)
                    print(cmd)
                    result.writerow(cmd)
                    device_close(uart, cam)
                    for f in exportfiles:
                        if f[0]:
                            print("close " + f[0].name)
                            f[0].close()
                    beepsound.set_tempo(60)
                    beepsound.FurElise()
                    print("FAIL")
                    sys.exit(1)

    if is_passed == True:
        device_close(uart, cam)
        for f in exportfiles:
            if f[0]:
                print("close " + f[0].name)
                f[0].close()
        beepsound.set_tempo(120)
        beepsound.Menuet()
        print("PASS")
        sys.exit(0)

main()

付録B. Lチカで始めるテスト自動化・記事一覧

電子書籍化したものを技術書典のka'sらぼで頒布しています。