Skip to main content

pypi build status pyver

HCLI hc

HCLI hc is a python package wrapper that contains an HCLI sample application (hc); hc can can act both as a gcode streamer (e.g. for OpenBuilds Blackbox controller v1.1g) and CNC interface. In other words, this HCLI acts in the same capacity as the OpenBuilds CONTROL software or OpenBuilds Interface CNC Touch hardware to help control a GRBL v1.1g controlled CNC.


HCLI hc wraps hc (an HCLI) and is intended to be used with an HCLI Client [1] as presented via an HCLI Connector [2].

You can find out more about HCLI on hcli.io [3]

[1] https://github.com/cometaj2/huckle

[2] https://github.com/cometaj2/hcli_core

[3] http://hcli.io

Installation

HCLI hc requires a supported version of Python and pip.

You’ll need an HCLI Connector to run hc. For example, you can use HCLI Core (https://github.com/cometaj2/hcli_core), a WSGI server such as Green Unicorn (https://gunicorn.org/), and an HCLI Client like Huckle (https://github.com/cometaj2/huckle).

pip install hcli-hc
pip install hcli-core
pip install huckle
pip install gunicorn
gunicorn --workers=1 --threads=1 -b 127.0.0.1:8000 "hcli_core:connector(\"`hcli_hc path`\")"

Usage

Open a different shell window.

Setup the huckle env eval in your .bash_profile (or other bash configuration) to avoid having to execute eval everytime you want to invoke HCLIs by name (e.g. hc).

Note that no CLI is actually installed by Huckle. Huckle reads the HCLI semantics exposed by the API via HCLI Connector and ends up behaving like the CLI it targets.

huckle cli install http://127.0.0.1:8000
eval $(huckle env)
hc help

Versioning

This project makes use of semantic versioning (http://semver.org) and may make use of the “devx”, “prealphax”, “alphax” “betax”, and “rcx” extensions where x is a number (e.g. 0.3.0-prealpha1) on github.

Supports

  • Gcode streaming

  • Immediate/realtime GRBL command execution (including during gcode streaming)

  • Gcode job sequences

  • CNC jogging (continuous, incremental, imperial, and metric)

  • Automated serial port scanning and connectivity (hc connect)

To Do

  • Update GRBL controller to include support for additional commands and/or echo of hexadecimal values.

  • Update hc to include job removal, insertion and resequencing.

  • Update hc to function in a multi-process environment (e.g. multiple workers in gunicorn).

  • Implement GRBL emulation tests for hc.

Bugs

Metadata

Release files for hcli-hc 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hcli-hc 0.5.2
File Size Uploaded
hcli_hc-0.5.2.tar.gz 21.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hcli-hc 0.5.2
File Interpreter ABI Platform
hcli_hc-0.5.2-py3-none-any.whl Python 3 none any Details

Total release size: 46.7 kB

Release files / hcli_hc-0.5.2.tar.gz

Download URL hcli_hc-0.5.2.tar.gz
Size 21.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0dbf0257024b4a5b8d4d514090ae06b79e5f28bc05c8f1204ea332436057819b
BLAKE2b-256 checksum
How to use checksums
e0f1dd8c93edea15e1b8a6ba58bd79b28aa8f56cb40f2c0afa5c54b11b6f9181
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.3

Release files / hcli_hc-0.5.2-py3-none-any.whl

Download URL hcli_hc-0.5.2-py3-none-any.whl
Size 24.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3d13c075a0a2e4c0e85c8036e7a8650b4a749d22fa70410e7ef28c0bed882c54
BLAKE2b-256 checksum
How to use checksums
bdae284f2a8c2aed9cb598ac230bcabb33d5a0e0908a1d09be65f37855da79a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.3

Release history Release notifications | RSS feed

This release

0.5.2 This release

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.0

2 release files

0.1.14

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page