Skip to main content

HC-SR04 Python module via Serial protocol

Project description

HC-SR04_Python-library

HC-SR04_Python-library for PyPi

https://pypi.org/project/HC-SR04

Getting Started

Prerequisites

Installation

$ pip install HC-SR04

Usage

Import

from HC_SR04 import HC_SR04 as hc
from HC_SR04 import HC_SR04_fair as hc_fair

tmp = hc()
tmp_fair = hc_fair()
import HC_SR04

tmp = HC_SR04.HC_SR04()
tmp_fair = HC_SR04.HC_SR04_fair()
from HC_SR04 import HC_SR04_fair
from HC_SR04 import HC_SR04

tmp = HC_SR04()
tmp_fair = HC_SR04_fair()

Examples

from HC_SR04 import HC_SR04 as hc # single board with HC_SR04(1 to many)

my_arduino = hc(channel = 3, open=True) # if open is set True then open Serial connection, default open is False

print(my_arduino.get())
from HC_SR04 import HC_SR04_fair # single board with HC_SR04(1 to many)

my_arduino_fair = HC_SR04_fair(channel = 3, port_left = '/dev/ttyUSB3', port_right = '/dev/ttyUSB4')
# call open_serial() before using .get* method()
# or set open = True, e.g., my_arduino_fair = HC_SR04_fair(channel = 3, open = True)
my_arduino_fair.open_serial()

print(my_arduino_fair.get())
print(my_arduino_fair.get_leftside())
print(my_arduino_fair.get_left_sensors())

# print out status of instance
my_arduino_fair.test()
# switch left <-> right 
my_arduino.switch()
# print out status of instance
my_arduino_fair.test()

my_arduino_fair.close_serial()

Dev

Build

$ python3 -m build

Local test

$ pip install -e .

Build and Local test

$ python3 -m build && pip install -e . && python

Release

$ python -m twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

HC_SR04-0.3.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

HC_SR04-0.3.1-py3-none-any.whl (16.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page