Changelog

Optical character recognition filter release notes

v0.5.6 - 2024-05-19

Added

• Add image pre-processing logic to enhance image for easy-ocr in case no-text is detected

Fixed

• Updated default value of item-quantity from "" to "1"

v0.5.5 - 2024-05-16

Added

• Add video_chunks in the payload

v0.5.4 - 2024-05-16

Fixed

• Added transaction_status update logic. ENG-1373
• Replaced external_id_type with external_id. ENG-1371
• Fixed Incorrectly detecting PROMO labels as line items. ENG-1374

v0.5.3 - 2025-05-15

Feature

• Added frame_skip variable

Fix

• Small tweaks to improve FPS

v0.5.2 - 2024-05-08

Fixed

• Changed the template for the temporary JSON Formatter.

v0.5.1 - 2024-05-05

Added

• Temporary JSON formater. It can be configure thru the boolean transform_to_mqtt variable. This will later be remove once the JSONOutputFormaterFilter is published.

v0.5.0 - 2025-05-02

Added

• Enhanced documentation with feature descriptions:
  • Added detailed topic-based processing capabilities
  • Documented flexible output options (JSON file and metadata forwarding)
  • Added environment variable configuration section
  • Improved configuration reference table with all available options
• Added example JSON outputs for both file and metadata formats
• Added multi-camera system use case

Changed

• Updated default configuration values in documentation to match implementation
• Improved feature organization and readability
• Added note about I/O considerations for streaming output

v0.4.15 - 2024-04-29

Added

• Added support for topic_pattern configuration to selectively OCR frames based on topic name matching.
  • New environment variable: FILTER_TOPIC_PATTERN
  • Supports regular expressions to match topics.
• Skips frames if their topic name does not match the specified pattern.

Changed

• Updated documentation:
  • Added detailed class and method docstrings.
  • Clarified configuration attributes and processing steps.

v0.4.14 - 2024-04-28

Added

• OCR filter can now optionally forward detected texts into frame.data['meta']['ocr_texts']
  • Controlled via the forward_ocr_texts setting (default: true)
  • Allows downstream filters to consume OCR results without reading from external files

Changed

• OCR filter writing to output JSON file is now fully optional
  • Controlled via the write_output_file setting (default: true)
  • When disabled, no file I/O is performed
• OCR filter now supports overriding any of its configuration from environment variables
  • Fields like ocr_engine, ocr_language, debug, forward_ocr_texts, write_output_file, etc. can be overridden using FILTER_* environment variables
  • Supports loading from .env files as well
• Improved robustness of OCR configuration parsing
  • Correct handling of booleans, lists (like ocr_language), and validation of engine choice
  • Clear error messages if invalid environment variables are provided
• Fixed redundant double OCR calls for Tesseract
  • Reduced unnecessary processing when extracting text lines
• Improved shutdown behavior in OCR filter
  • Proper logging depending on whether output file writing was enabled
• Internal improvements

Fixed

• FILTER_OCR_LANGUAGE is now parsed correctly

v0.4.13 - 2024-03-21

Added

• Internal improvements