tsf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8dd49df524555e9c11369bba05b4c55855a972ead2493da6bd03aedb5ffbee55
+  data.tar.gz: 94d338f36c27841fa5efc52b83060c3788a01fd5df5687be82db1b0e260f88e3
+SHA512:
+  metadata.gz: 11c7ba675c35eb3be2f35d08e3f9f694a5336d87994f8ab338cdeafa0f67ac9507be1674be52dd0bfb456f8d15a62a3e85bbaaeb1d4c40f3d331e1448e060f87
+  data.tar.gz: ab80180d202b2f7ab15b956c86488b3aca4a90fe7aa5cfa5b75fe9438fd4d0d26a45f631e220b1baf73f63003f2c9f00fa70f6d4a9e9116f29a4919288e880ed

data/README.md

@@ -0,0 +1,23 @@
+# TSF.rb
+Ruby parser for Trotect's TSF file format. The TSF file format is the main format of [Trotec's JobControl software](https://www.troteclaser.com/de/lasermaschinen/jobcontrol). JobControl is the key piece of software between a design in illustrator and a trotec laser machine. To create a TSF, you _print_ from design software to JobControl to generate a TSF with vector lines and bitmaps for cutting and engraving. Typically these files are only previewable by JobControl, making it difficult to share & reuse files within an organisation with confidence.
+
+This Ruby Gem is used as an interface with the TSF file format to read metadata, bitmap, and polygon data, as well as generate previews of the files without the need for JobControl or design software. 
+
+# Get started
+## Instalation
+
+```bash
+bundle install tsf
+```
+
+## How to use
+
+```ruby
+require 'tsf'
+
+data = File.read('to/your/file.tsf')
+vector = TSF::Vector.load_tsf(data)
+
+vector.loaded
+# => True
+```

data/lib/tsf/convert/tsf_to_image.rb

@@ -0,0 +1,14 @@
+module Converter
+  # Converts a TSF file to an image format (PNG, JPG, etc.)
+  class TsfToImage
+    def initialize(tsf_file_path)
+      @tsf_file_path = tsf_file_path
+    end
+
+    def convert_to_image(output_format)
+      # Logic to convert TSF to image
+      puts "Converting #{@tsf_file_path} to #{output_format}..."
+      # Conversion logic goes here
+    end
+  end
+end

data/lib/tsf/convert/tsf_to_svg.rb

@@ -0,0 +1,14 @@
+module Converter
+  # Converts a TSF file to an SVG format
+  class TsfToSvg
+    def initialize(tsf_file_path)
+      @tsf_file_path = tsf_file_path
+    end
+
+    def convert_to_svg
+      # Logic to convert TSF to SVG
+      puts "Converting #{@tsf_file_path} to SVG..."
+      # Conversion logic goes here
+    end
+  end
+end

data/lib/tsf/vector.rb

@@ -0,0 +1,168 @@
+module Tsf
+  # Loads a TSF file and parses its content
+  class Vector
+    attr_reader :loaded, :grouped_data, :polygons, :headers
+    attr_reader :material_group, :material_name, :job_name, :job_number, :resolution, :size, :bitmap
+
+    # Initialize the Vector class
+    def initialize
+      @loaded = false
+      @grouped_data = nil
+      @polygons = []
+      @headers = []
+
+      ## Header information. Deconstructed.
+      # Material settings for the job.
+      @material_group = nil
+      @material_name = nil
+
+      # Job name as set in the Trotec software.
+      @job_name = nil
+      @job_number = nil
+
+      # Usualy 500 DPI.
+      @resoultion = nil
+      # Will be set artboard size. when creating the tsf.
+      @size = nil
+
+      ## Image Data
+      # Images in TSF files are stored as a monochrome bitmap.
+      # The bitmap is used to determine the engraving area.
+      # Image data, if present.
+      @bitmap = nil
+
+      #####
+
+      # Minimum required variables to be present in the TSF file.
+      # CamelCase
+      @min_vars = ['MaterialGroup', 'MaterialName', 'JobName', 'JobNumber', 'Resolution', 'Size']
+    end
+
+    # Data is the raw data from the TSF file.
+    # data = File.read('path/to/file.tsf')
+    def self.load_tsf(data)
+      vector = new
+      if data.is_a?(String) 
+
+        # Check if the data is empty
+        if data.empty?
+          raise ArgumentError, "Data is empty. Please provide a valid TSF file."
+        end
+
+        # Parse vector data
+        vector.parse_tsf(data)
+      else
+        raise ArgumentError, "Expected a String, got #{data.class}"
+      end
+      vector
+    end
+
+  
+    def parse_tsf(data)
+      # Tsf files are text formatted files that repsresnte vector paths for a Troctec laser to follow. Similar to that of Gcode.
+      # TSF file use a xml-like format the prefix "BegGroup" and "EndGroup" to denote the start and end of a group of commands or meta data.
+      # TSF files are structed it to 4 top level groups.
+      # - Header - Contains the header information of the file.
+      # - JobMeta - Contains meta data about the job, such as the name, date, and other information.
+      # - Bitmap - Contains the engraving data, such as the image to be engraved.
+      # - DrawCommands - Contains the vector data, such as the paths to be followed by the laser.
+      #     - contains many "DrawPolygon" commands, which are the actual vector paths to be followed by the laser.
+      #     - Each "DrawPolygon" command contains a list of points, which are the coordinates of the points to be followed by the laser. Delimtited by a ;.
+      #     - The first 4 digits of the command contain, ID, then R,G,B color values of the Polygon.
+
+      @grouped_data = get_grouped_data(data)
+
+      # Check if the grouped data has the required groups
+      # A TSF file is not complete if it does not have a header and draw commands.
+      unless @grouped_data.key?('Header') || @grouped_data.key?('DrawCommands')
+        raise ArgumentError, "Invalid TSF data. Missing required groups core groups: Header, DrawCommands"
+      end
+
+      # Check if the grouped data has the required keys
+      missing_headers = @min_vars - @grouped_data['Header'].keys
+      if missing_headers.any?
+        raise ArgumentError, "Invalid TSF data. Missing required headers: #{missing_headers.join(', ')}"
+      end
+
+
+      @material_group = @grouped_data['Header']['MaterialGroup']
+      @material_name = @grouped_data['Header']['MaterialName']
+
+      @job_name = @grouped_data['Header']['JobName']
+      @job_number = @grouped_data['Header']['JobNumber']
+
+      @resolution = @grouped_data['Header']['Resolution'].to_i
+      @size = @grouped_data['Header']['Size'].split(";").map(&:to_f)
+
+      @polygons = get_polygons(@grouped_data)
+
+      @loaded = true
+      @grouped_data
+    end
+
+    def get_grouped_data(data)
+      # Groups are delimited by the "BegGroup" and "EndGroup" tags.
+      # Each group contains a list of commands or meta data.
+      # The normal groups are:
+      # - Header
+      # - JobMeta
+      # - Bitmap (optional)
+      # - DrawCommands
+
+      # Auto create nested hash when accessed.
+      nested_group_and_values = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+      # Typically, we only get 2 levels of groups. But we can have more.
+      current_groups = []
+
+      data.split("\n").each do |line|
+        # a line is a command and a value. ie. <JobNumber: 1234> or <DrawPolygon: 12;0;1;2;3>
+        # a line can define a group where value is the group name. ie. <BegGroup: Header> <EndGroup: Header>
+        # groups can have groups (max 2.)
+        # groups can have multple commands.
+        # a command has only one value.
+
+        command, value = line.split(":").map(&:strip).map { |s| s.gsub(/<|>/, '') }
+        
+        case command
+        when "BegGroup"
+          # Start a new group
+          current_groups << value
+        when "EndGroup"
+          # End the current group
+          current_groups.pop
+        else
+          # Assign the command and value to the appropriate group
+          if current_groups.any?
+            current = nested_group_and_values.dig(*current_groups)
+            current[command] = value
+          end
+        end
+
+      end
+      nested_group_and_values
+    end
+
+    def get_polygons(grouped_data)
+      polygons = []
+      grouped_data['DrawCommands'].each do |key, value|
+        polygon_string = value['DrawPolygon']
+        polygon_array = polygon_string.split(";")
+
+        polygon = {
+          'id': polygon_array[0].to_i,
+          'color': {
+            'r': polygon_array[1].to_i,
+            'g': polygon_array[2].to_i,
+            'b': polygon_array[3].to_i,
+          },
+          'points': []
+        }
+
+        polygon[:data] = polygon_array.drop(4).map(&:to_i).each_slice(2).to_a
+
+        polygons << polygon
+      end
+      polygons
+    end
+  end
+end

data/lib/tsf/version.rb

@@ -0,0 +1,3 @@
+module Tsf
+  version = "0.1.0"
+end

data/lib/tsf.rb

@@ -0,0 +1,10 @@
+# Primary Loader
+require_relative 'tsf/vector'
+
+# Conversion tools
+require_relative 'tsf/convert/tsf_to_image'
+require_relative 'tsf/convert/tsf_to_svg'
+
+
+module Tsf
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: tsf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Isaac Bonora
+bindir: bin
+cert_chain: []
+date: 2025-04-14 00:00:00.000000000 Z
+dependencies: []
+description: Ruby parser for Trotec's TSF file format.
+email: isaac@isbonora.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/tsf.rb
+- lib/tsf/convert/tsf_to_image.rb
+- lib/tsf/convert/tsf_to_svg.rb
+- lib/tsf/vector.rb
+- lib/tsf/version.rb
+homepage: https://rubygems.org/gems/tsfrb
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Ruby parser for Trotec's TSF file format.
+test_files: []