gcodeparser

https://pypi.org/project/gcodeparser/
Admin
A simple gcode parser that can be used to parse a gcode file into python GcodeLine objects.
Tokens:2,653
Snippets:42
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install gcodeparser from GitHub

Source: https://pypi.org/project/gcodeparser

Alternative installation method for gcodeparser directly from its GitHub repository using pip.

```bash
pip install -e "git+https://github.com/AndyEveritt/GcodeParser.git@master#egg=gcodeparser"
```

--------------------------------

### Install gcodeparser using pip

Source: https://pypi.org/project/gcodeparser/0.3.0

Install the gcodeparser library using pip. Alternatively, install from a Git repository.

```bash
pip install gcodeparser
```

```bash
pip install -e "git+https://github.com/AndyEveritt/GcodeParser.git@master#egg=gcodeparser"
```

--------------------------------

### Install gcodeparser using pip

Source: https://pypi.org/project/gcodeparser

Standard installation command for the gcodeparser library using pip.

```bash
pip install gcodeparser
```

--------------------------------

### GcodeLine object representation with comments

Source: https://pypi.org/project/gcodeparser/0.3.0

Example of how a comment-only line is represented when `include_comments=True`.

```python
GcodeLine(
  command = (';', None),
  params = {},
  comment = 'this comment will only be included if `include_comments=True`',
)
```

--------------------------------

### Get G-code command as string

Source: https://pypi.org/project/gcodeparser/0.3.0

Access the `command_str` property of a GcodeLine object to get the command tuple as a string (e.g., ('G', 91) becomes "G91").

```python
line.command_str
```

--------------------------------

### Retrieve a parameter from a GcodeLine

Source: https://pypi.org/project/gcodeparser/0.3.0

Use the `get_param` method to retrieve the value of a specific parameter from a GcodeLine. Optional `return_type` and `default` values can be provided.

```python
line.get_param('X')
```

--------------------------------

### GcodeLine Object Structure

Source: https://pypi.org/project/gcodeparser/0.3.0

Represents a parsed line from a G-code file. It includes the command, parameters, comment, line index, and command type.

```python
GcodeLine(
  command = ('G', 1),
  params = {'X': 10, 'Y': -2.5},
  comment = 'this is a comment',
  line_index = 0,
  type = Commands.MOVE # Commands.MOVE, Commands.COMMENT, Commands.OTHER, Commands.TOOLCHANGE
)

```

--------------------------------

### Convert GcodeLine back to G-code string

Source: https://pypi.org/project/gcodeparser/0.3.0

Use the `gcode_str` property to convert a GcodeLine object back into its equivalent G-code string representation.

```python
line.gcode_str
```

--------------------------------

### Parse G-code lines from a file

Source: https://pypi.org/project/gcodeparser/0.3.0

Parse G-code lines from a file by iterating over them. Ensure the file remains open during iteration. Alternatively, parse all lines into a list.

```python
from gcodeparser import parse_gcode_lines

# Recommended: iterate over lines in a file
with open('my_gcode.gcode', 'r') as f: # note that file should be open during iteration
    for line in parse_gcode_lines(f, include_comments=False):
        print(line)

# Alternative: open gcode file and parse lines into a list without iteration
with open('my_gcode.gcode', 'r') as f:
    lines = list(parse_gcode_lines(f, include_comments=False))
```

```python
# Also, we can convert string to parsed lines
with open('my_gcode.gcode', 'r') as f:
    gcode = f.read()
lines = list(parse_gcode_lines(gcode, include_comments=False))
```

--------------------------------

### Parse G-code Lines from File

Source: https://pypi.org/project/gcodeparser

Iterate over G-code lines from a file or parse them into a list. Ensure the file remains open during iteration. This method is suitable for processing large G-code files efficiently.

```python
from gcodeparser import parse_gcode_lines

# Recommended: iterate over lines in a file
with open('my_gcode.gcode', 'r') as f:
    for line in parse_gcode_lines(f, include_comments=False):
        print(line)

# Alternative: open gcode file and parse lines into a list without iteration
with open('my_gcode.gcode', 'r') as f:
    lines = list(parse_gcode_lines(f, include_comments=False))

# Also, we can convert string to parsed lines
with open('my_gcode.gcode', 'r') as f:
    gcode = f.read()
lines = list(parse_gcode_lines(gcode, include_comments=False))
```

--------------------------------

### Convert GcodeLine objects to a pandas DataFrame

Source: https://pypi.org/project/gcodeparser/0.3.0

Convert a list of GcodeLine objects into a pandas DataFrame for easier data manipulation and analysis.

```python
from gcodeparser import parse_gcode_lines
import pandas as pd

with open('my_gcode.gcode', 'r') as f:
    lines = list(parse_gcode_lines(f))
df = pd.DataFrame(lines)
```

--------------------------------

### Parse G-code with comments included

Source: https://pypi.org/project/gcodeparser/0.3.0

Parse G-code and include lines that only contain comments by setting `include_comments=True`. Comment lines will be represented as GcodeLine objects with command (';', None).

```python
from gcodeparser import parse_gcode_lines

gcode = """G1 X1 ; this comment is always included
; this comment will only be included if `include_comments=True`"""

lines = list(parse_gcode_lines(gcode, include_comments=True))
```

--------------------------------

### Update a parameter in a GcodeLine

Source: https://pypi.org/project/gcodeparser/0.3.0

Use the `update_param` method to change the value of an existing parameter or add a new one to a GcodeLine.

```python
line.update_param('X', 10)
```

--------------------------------

### Delete a parameter from a GcodeLine

Source: https://pypi.org/project/gcodeparser/0.3.0

Use the `delete_param` method to remove a parameter from a GcodeLine.

```python
line.delete_param('X')
```
Tokens:
Raw