BowCar Module for Python

한국어 | English

---

🇰🇷 한국어 (Korean)

BowCar는 파이썬을 이용해 아두이노 기반의 바우카 하드웨어를 제어하고 학습하기 위한 모듈입니다.

빠른 시작 (Quick Start)

이 모듈을 사용하기 위해서는 Arduino CLI 설치가 필수입니다.

pip install bowcar

API 레퍼런스 (명령어 목록)

0. 시간 제어

함수	설명
BowCar.delay(time)	time(ms)만큼 프로그램을 지연시킵니다.

1. LED 및 네오픽셀 제어

함수	설명
BowCar.red(status)	빨간색 LED를 제어합니다. (status: 'on'/'off')
BowCar.blue(status)	파란색 LED를 제어합니다. (status: 'on'/'off')
BowCar.all_light(status)	모든 LED를 제어합니다. (status: 'on'/'off')
BowCar.neopixel(index, r, g, b)	특정 인덱스(0부터 3까지)의 네오픽셀 색상을 설정합니다. (r,g,b: 0~255)
BowCar.neopixel_all(r, g, b)	모든 네오픽셀의 색상을 설정합니다.
BowCar.neopixel_clear()	모든 네오픽셀을 끕니다.
BowCar.neopixel_brightness(val)	네오픽셀의 밝기를 조절합니다. (0~255)

2. 모터 제어

함수	설명
BowCar.motor(left, right)	왼쪽/오른쪽 모터 속도 및 방향을 제어합니다. (-255 ~ 255) 양수: 전진, 음수: 후진, 0: 정지

3. 센서 값 읽기

함수	설명
BowCar.get_button(button)	버튼 상태를 확인합니다. (button: 'u', 'd', 'l', 'r')
BowCar.is_button_pressed(btn)	버튼이 눌렸는지 확인합니다. (True/False)
BowCar.get_light()	조도 센서 값을 읽어옵니다. (0~1023)
BowCar.get_sound()	소리 센서 값을 읽어옵니다. (0~1023)
BowCar.get_line(dir)	라인 센서 값을 읽어옵니다. (dir: 'l', 'r')
BowCar.get_distance()	초음파 센서 거리 값을 읽어옵니다. (cm)

4. 센서 조건 확인

모든 조건 함수는 threshold(임계값)와 condition(조건: '>', '<')을 인자로 받습니다.

함수	설명
BowCar.check_light(th, cond)	조도 센서 조건 확인
BowCar.check_sound(th, cond)	소리 센서 조건 확인
BowCar.check_line(dir, th, cond)	라인 센서 조건 확인
BowCar.check_distance(th, cond)	거리 센서 조건 확인

5. 코드 생성 제어문 (Upload 모드 전용)

함수	설명
bfor("초기화; 조건; 변화")	C++ 스타일의 for문을 생성합니다.
bwhile("조건")	while문을 생성합니다.
bif("조건"), belif, belse	if-else 조건문을 생성합니다.
bbreak()	반복문을 탈출합니다.
set_value(type, name, val)	변수를 선언하거나 값을 설정합니다.
set_array(type, name, values)	배열을 선언하고 초기화합니다. (values: list)
set_array_value(name, index, value)	배열의 특정 인덱스 값을 변경합니다.

사용 예시

💡 Tip: 더 많은 예제 코드는 examples/ 디렉토리 하위의 upload/(파이썬 코드를 아두이노에 업로드)와 live/(컴퓨터와 직접 연결하여 실시간 제어) 폴더에서 확인하고 직접 실행해 볼 수 있습니다!

1. 기본 제어 (LED, 모터, 시간)

from bowcar import UploadBowCar

car = UploadBowCar()

# LED 켜기/끄기
car.red('on')
car.delay(1000)
car.red('off')

# 모터 제어 (전진, 후진, 정지)
car.motor(100, 100)   # 전진
car.delay(1000)
car.motor(-100, -100) # 후진
car.delay(1000)
car.motor(0, 0)       # 정지

car.upload_code()

2. 센서 활용 및 조건문

from bowcar import UploadBowCar

car = UploadBowCar()

# 무한 반복 (loop)
with car.bwhile("True"):
    # 버튼이 눌렸는지 확인
    with car.bif("is_button_pressed('u')"):
        car.all_light('on')

    # 조도 센서 값이 500보다 작으면 (어두우면)
    with car.belif("check_light(500, '<')"):
        car.red('on')

    with car.belse():
        car.all_light('off')

car.upload_code()

3. 네오픽셀 제어

from bowcar import UploadBowCar

car = UploadBowCar()

# 전체 빨간색 설정
car.neopixel_all(255, 0, 0)
car.delay(1000)

# 개별 제어 (0번: 초록, 1번: 파랑)
car.neopixel(0, 0, 255, 0)
car.neopixel(1, 0, 0, 255)
car.delay(1000)

# 밝기 조절
car.neopixel_brightness(50) # 밝기 50으로 설정

# 끄기
car.neopixel_clear()

car.upload_code()

4. 배열 사용하기 (Array Usage)

from bowcar import UploadBowCar

car = UploadBowCar()

# 1. 배열 선언 및 초기화
# int myArr[] = {10, 20, 30};
car.set_array("int", "myArr", [10, 20, 30])

# 2. 배열 값 사용
# for(int i=0; i<3; i++) { ... }
with car.bfor("int i=0; i<3; i++"):
    # 네오픽셀 밝기를 배열 값으로 설정
    car.neopixel_brightness("myArr[i]")
    car.delay(1000)

# 3. 배열 값 변경
# myArr[0] = 100;
car.set_array_value("myArr", 0, 100)

car.upload_code()

---

🇺🇸 English

BowCar is a Python module for controlling and learning with the Arduino-based BowCar hardware.

Quick Start

Arduino CLI is required to use this module.

pip install bowcar

API Reference

0. Time Control

Function	Description
BowCar.delay(time)	Delays the program for time milliseconds.

1. LED & NeoPixel Control

Function	Description
BowCar.red(status)	Controls Red LED. (status: 'on'/'off')
BowCar.blue(status)	Controls Blue LED. (status: 'on'/'off')
BowCar.all_light(status)	Controls all LEDs. (status: 'on'/'off')
BowCar.neopixel(idx, r, g, b)	Sets color of specific NeoPixel (idx: from 0 to 3). (0~255)
BowCar.neopixel_all(r, g, b)	Sets color of all NeoPixels.
BowCar.neopixel_clear()	Turns off all NeoPixels.
BowCar.neopixel_brightness(val)	Sets brightness of NeoPixels. (0~255)

2. Motor Control

Function	Description
BowCar.motor(left, right)	Controls motor speed and direction. (-255 ~ 255) Positive: Forward, Negative: Backward, 0: Stop

3. Read Sensors

Function	Description
BowCar.get_button(button)	Gets button status. (button: 'u', 'd', 'l', 'r')
BowCar.is_button_pressed(btn)	Checks if button is pressed. (True/False)
BowCar.get_light()	Reads light sensor value. (0~1023)
BowCar.get_sound()	Reads sound sensor value. (0~1023)
BowCar.get_line(dir)	Reads line sensor value. (dir: 'l', 'r')
BowCar.get_distance()	Reads ultrasonic sensor distance. (cm)

4. Check Sensor Conditions

All check functions take threshold and condition ('>', '<') as arguments.

Function	Description
BowCar.check_light(th, cond)	Checks light sensor condition.
BowCar.check_sound(th, cond)	Checks sound sensor condition.
BowCar.check_line(dir, th, cond)	Checks line sensor condition.
BowCar.check_distance(th, cond)	Checks distance sensor condition.

5. Code Generation Control (Upload Mode Only)

Function	Description
bfor("init; cond; step")	Generates C++ style for loop.
bwhile("condition")	Generates while loop.
bif("cond"), belif, belse	Generates if-else statements.
bbreak()	Generates break statement.
set_value(type, name, val)	Declares variable or sets value.
set_array(type, name, values)	Declares and initializes an array. (values: list)
set_array_value(name, index, value)	Modifies a specific index value of an array.

Usage Examples

💡 Tip: Check out the examples/ directory (upload/ for standalone execution and live/ for real-time control via PC) for more runnable example scripts!

1. Basic Control (LED, Motor, Time)

from bowcar import UploadBowCar

car = UploadBowCar()

# LED Control
car.red('on')
car.delay(1000)
car.red('off')

# Motor Control (Forward, Backward, Stop)
car.motor(100, 100)   # Forward
car.delay(1000)
car.motor(-100, -100) # Backward
car.delay(1000)
car.motor(0, 0)       # Stop

car.upload_code()

2. Sensors & Conditions

from bowcar import UploadBowCar

car = UploadBowCar()

# Infinite Loop
with car.bwhile("True"):
    # Check if button is pressed
    with car.bif("is_button_pressed('u')"):
        car.all_light('on')

    # Check light sensor (if darker than threshold 500)
    with car.belif("check_light(500, '<')"):
        car.red('on')

    with car.belse():
        car.all_light('off')

car.upload_code()

3. NeoPixel Control

from bowcar import UploadBowCar

car = UploadBowCar()

# Set all to Red
car.neopixel_all(255, 0, 0)
car.delay(1000)

# Individual Control (0: Green, 1: Blue)
car.neopixel(0, 0, 255, 0)
car.neopixel(1, 0, 0, 255)
car.delay(1000)

# Set Brightness
car.neopixel_brightness(50)

# Clear
car.neopixel_clear()

car.upload_code()

4. Using Arrays

from bowcar import UploadBowCar

car = UploadBowCar()

# 1. Declare and initialize array
# int myArr[] = {10, 20, 30};
car.set_array("int", "myArr", [10, 20, 30])

# 2. Use array values
# for(int i=0; i<3; i++) { ... }
with car.bfor("int i=0; i<3; i++"):
    # Set NeoPixel brightness using array value
    car.neopixel_brightness("myArr[i]")
    car.delay(1000)

# 3. Modify array value
# myArr[0] = 100;
car.set_array_value("myArr", 0, 100)

car.upload_code()