Skip to main content

HCLI hc is a pypi 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.

Project description

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

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

hcli_hc-0.5.1.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hcli_hc-0.5.1-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file hcli_hc-0.5.1.tar.gz.

File metadata

  • Download URL: hcli_hc-0.5.1.tar.gz
  • Upload date:
  • Size: 51.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.11

File hashes

Hashes for hcli_hc-0.5.1.tar.gz
Algorithm Hash digest
SHA256 fdada3f11211f98d3e75b9ea2340427f79bf47f7623769baaeaa5b158125e8a8
MD5 36c55d30f960af99fab9fd53e65bd9da
BLAKE2b-256 619bcfd214f7ea52d7b5888d27fd5f3a0d96c8d25f3d06ca4e043a1ec57b632c

See more details on using hashes here.

File details

Details for the file hcli_hc-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: hcli_hc-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.11

File hashes

Hashes for hcli_hc-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4caecb5fd5cc1a15c8bb044a668e82b566bc1e024054ec9b13423ea0d1d947d
MD5 eaffd1d6a513403615720959a2ac1295
BLAKE2b-256 99612759d49844f3bab75fe0baa8278b541ef26950bf426b84e38420ba822f13

See more details on using hashes here.

Supported by

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