Download the PHP package np-shop/php-bgcode without Composer

On this page you can find all versions of the php package np-shop/php-bgcode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of np-shop/php-bgcode

Informations about the package php-bgcode

php-bgcode

PHP reader for Prusa Binary Gcode files.

This library reads Binary Gcode streams into typed blocks and exposes the main file surfaces through BgCode.

Installation

Usage

BgCode::open(string $path): self

Opens a BGCode file from disk and returns a BgCode instance.

BgCode::fromStream($stream): self

Builds a BgCode instance from an open binary stream resource.

BgCode::header(): FileHeader

Returns the parsed file header.

BgCode::blocks(): \Generator

Returns every parsed block in order as a generator.

BgCode::gcode(): \Generator

Returns decoded G-code chunks from all G-code blocks.

BgCode::metadata(): array

Returns metadata blocks keyed by block class name.

BgCode::thumbnails(): array

Returns all thumbnail blocks.

Tests

The repository includes a fixture at tests/Fixtures/test.bgcode used by the unit tests for metadata, G-code, header, and thumbnail reading.

Block types

BgCode::blocks() returns typed block objects.

Shared methods

Method Description Returns
header() Returns the parsed block header. BlockHeader
parameters() Returns the raw block parameters. string
data() Returns the raw block payload. string
checksum() Returns the block checksum when present. ?int
type() Returns the block type enum. BlockType

BlockType::FileMetadata

Method Description Returns
encoding() Returns the metadata encoding. MetadataEncodingType
text() Returns the raw metadata text. string
values() Returns decoded metadata key/value pairs. array

BlockType::GCode

Method Description Returns
encoding() Returns the G-code encoding. GCodeEncodingType
decoded(GCodeDecoder $decoder) Returns decoded G-code text using the provided decoder. string

BlockType::SlicerMetadata

Method Description Returns
encoding() Returns the metadata encoding. MetadataEncodingType
text() Returns the raw metadata text. string
values() Returns decoded metadata key/value pairs. array

BlockType::PrinterMetadata

Method Description Returns
encoding() Returns the metadata encoding. MetadataEncodingType
text() Returns the raw metadata text. string
values() Returns decoded metadata key/value pairs. array

BlockType::PrintMetadata

Method Description Returns
encoding() Returns the metadata encoding. MetadataEncodingType
text() Returns the raw metadata text. string
values() Returns decoded metadata key/value pairs. array

BlockType::Thumbnail

Method Description Returns
format() Returns the thumbnail image format. ThumbnailFormat
width() Returns the thumbnail width in pixels. int
height() Returns the thumbnail height in pixels. int

Status

Early architecture / development stage.

Implemented foundation:

Format reference

The upstream reference implementation is Prusa3D/libbgcode.

The PHP implementation is independent and should remain tested against real BGCode fixtures.

All versions of php-bgcode with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package np-shop/php-bgcode contains the following files

Loading the files please wait ...