oudon/rmqrcode-python

Rectangular Micro QR Code (rMQR Code) Generator in Python

Rectangular Micro QR Code (rMQR Code) Generator

The rMQR Code is a rectangular two-dimensional barcode. This is easy to print in narrow space compared to conventional QR Code. This package can generate an rMQR Code image. This is implemented based on ISO/IEC 23941: Rectangular Micro QR Code (rMQR) bar code symbology specification.

🎮 Online Demo Site

You can try this online: https://rmqr.oudon.xyz .

📌 Notice

• To read rMQR code, we can use QRQR app. However many other QR code readers may have not been supported yet.
• Please verify an image generated by this software whether it can decode correctly before use.

🚀 Installation

pip install rmqrcode

📕 Basic Usage

CLI

Generate an rMQR Code image from your command line, use rmqr command:

rmqr "Text data" "my_qr.png"

See the help to list the options:

➜ rmqr -h
usage: rmqr [-h] [--ecc {M,H}] [--version VERSION] [--fit-strategy {min_width,min_height,balanced}]
            DATA OUTPUT

positional arguments:
  DATA                  Data to encode.
  OUTPUT                Output file path

optional arguments:
  -h, --help            show this help message and exit
  --ecc {M,H}           Error correction level. (default: M)
  --version VERSION     rMQR Code version like 'R11x139'.
  --fit-strategy {min_width,min_height,balanced}
                        Strategy how to determine rMQR Code size.

Generate rMQR Code in scripts

Alternatively, you can also use in python scripts:

from rmqrcode import rMQR
import rmqrcode

data = "https://oudon.xyz"
qr = rMQR.fit(
    data,
    ecc=rmqrcode.ErrorCorrectionLevel.M,
    fit_strategy=rmqrcode.FitStrategy.MINIMIZE_WIDTH
)

The ecc parameter is an enum value of rmqrcode.ErrorCorrectionLevel to select error correction level. The following values are available:

• ErrorCorrectionLevel.M: Approx. 15% Recovery Capacity.
• ErrorCorrectionLevel.H: Approx. 30% Recovery Capacity.

The fit_strategy parameter is enum value of rmqrcode.FitStrategy to specify how to determine size of rMQR Code. The following values are available:

• FitStrategy.MINIMIZE_WIDTH: Try to minimize width.
• FitStrategy.MINIMIZE_HEIGHT: Try to minimize height.
• FitStrategy.BALANCED: Try to keep balance of width and height.

Here is an example of images generated by each fit strategies for data Test test test:

Save as image

from rmqrcode import QRImage

image = QRImage(qr, module_size=8)
image.show()
image.save("my_qr.png")

📙 Advanced Usage

Select rMQR Code size manually

To select rMQR Code size manually, use rMQR() constructor.

from rmqrcode import rMQR, ErrorCorrectionLevel
qr = rMQR('R11x139', ErrorCorrectionLevel.H)

R11x139 means 11 rows and 139 columns. The following table shows available combinations.

	27	43	59	77	99	139
R7	❌	✅	✅	✅	✅	✅
R9	❌	✅	✅	✅	✅	✅
R11	✅	✅	✅	✅	✅	✅
R13	✅	✅	✅	✅	✅	✅
R15	❌	✅	✅	✅	✅	✅
R17	❌	✅	✅	✅	✅	✅

Encoding Modes and Segments

The rMQR Code has the four encoding modes Numeric, Alphanumeric, Byte and Kanji to convert data efficiently. We can select encoding mode for each data segment separately. The following example shows how to encode data "123Abc". The first segment is for "123" in the Numeric mode. The second segment is for "Abc" in the Byte mode. We can select an encoding mode by passing the encoder_class argument to the rMQR#add_segment method. In this example, the length of bits after encoding is 47 in the case combined with the Numeric mode and the Byte mode, which is shorter than 56 in the Byte mode only.

from rmqrcode import rMQR, ErrorCorrectionLevel, encoder
qr = rMQR('R7x43', ErrorCorrectionLevel.M)
qr.add_segment("123", encoder_class=encoder.NumericEncoder)
qr.add_segment("Abc", encoder_class=encoder.ByteEncoder)
qr.make()

The value for encoder_class is listed in the below table.

Mode	Value of encoder_class	Characters
Numeric	NumericEncoder	0-9
Alphanumeric	AlphanumericEncoder	0-9 A-Z \s $ % * + - . / :
Byte	ByteEncoder	Any
Kanji	KanjiEncoder	from 0x8140 to 0x9FFC, from 0xE040 to 0xEBBF in Shift JIS value

Optimal Segmentation

The rMQR.fit method mentioned above computes the optimal segmentation. For example, the data "123Abc" is divided into the following two segments.

Segment No.	Data	Encoding Mode
Segment1	123	Numeric
Segment2	Abc	Byte

In the case of other segmentation like "123A bc", the length of the bit string after encoding will be longer than the above optimal case.

🤝 Contributing

Any suggestions are welcome! If you are interesting in contributing, please read CONTRIBUTING.

📚 References

• Rectangular Micro QR Code (rMQR) bar code symbology specification: ISO/IEC 23941
• rMQR Code | QRcode.com | DENSO WAVE
• Creating a QR Code step by step

---

The word "QR Code" is registered trademark of DENSO WAVE Incorporated.
http://www.denso-wave.com/qrcode/faqpatent-e.html

rmqrcode-python's Issues

Docstring

Change `qr_version` to instance variable of the `rMQR` class

Support multiple segmentation

Encoders return incorrect length value for multibyte character

Support multiple encoding mode

Add docstrings into `qr_image.py`

Allow binary data

Please allow embedding for binary data 🙏

`SegmentOptimizer#compute` should raise `DataTooLongError` when the given data length is too long

Raise a DataToLongError when QR version is given

Current Behavior

No error raised.

Expected Behavior

Raise DataToLongError

Environments

• package version: 0.1.0

unknown file extension: .png

with space:

C:\Users\SYM\Pictures>rmqr 'github.com/PixelSymbols' 'github profile.png'
usage: rmqr [-h] [--ecc {M,H}] [--version VERSION] [--fit-strategy {min_width,min_height,balanced}] DATA OUTPUT
rmqr: error: unrecognized arguments: profile.png'

Without space

C:\Users\SYM\Pictures>rmqr 'github.com/PixelSymbols' 'github_profile.png'
Traceback (most recent call last):
  File "C:\Users\SYM\AppData\Local\Programs\Python\Python312\Lib\site-packages\PIL\Image.py", line 2415, in save
    format = EXTENSION[ext]
             ~~~~~~~~~^^^^^
KeyError: ".png'"

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\Users\SYM\AppData\Local\Programs\Python\Python312\Scripts\rmqr.exe\__main__.py", line 7, in <module>
  File "C:\Users\SYM\AppData\Local\Programs\Python\Python312\Lib\site-packages\rmqrcode\console.py", line 61, in main
    _save_image(qr, args.OUTPUT)
  File "C:\Users\SYM\AppData\Local\Programs\Python\Python312\Lib\site-packages\rmqrcode\console.py", line 36, in _save_image
    image.save(output)
  File "C:\Users\SYM\AppData\Local\Programs\Python\Python312\Lib\site-packages\rmqrcode\qr_image.py", line 24, in save
    self._img.save(name)
  File "C:\Users\SYM\AppData\Local\Programs\Python\Python312\Lib\site-packages\PIL\Image.py", line 2418, in save
    raise ValueError(msg) from e
ValueError: unknown file extension: .png'

The rMQR class should have quiet zone

Summary

Make the rMQR class have the quiet zone.

Background

The rMQR code is surrounded by 2X light modules called quiet zone. This is defined in the ISO/IEC 23941 6.3.10 Quiet zone. However, currently implementation of the rMQR class has no quiet zone. When we generate an image file, QRImage class adds the quiet zone. If clients use the rMQR class directly, they should add the quiet zone in client-side.

Suggestion

Make the rMQR class have the quiet zone.

Add more test cases into SegmentsTest

Incorrect optimization

Bug in the SegmentOptimizer.

Summary

A cost computed by SegmentOptimizer is too small in Byte Mode. This bug causes invalid segmentation.

Current Behaviour

>>> qr._optimized_segments("点茗")
[{'data': '点茗', 'encoder_class': <class 'rmqrcode.encoder.byte_encoder.ByteEncoder'>}

Expected Behaviour

>>> qr._optimized_segments("点茗")
[{'data': '点茗', 'encoder_class': <class 'rmqrcode.encoder.byte_encoder.KanjiEncoder'>}

Multi-language support for rMQR online generator

Currently, rMQR online generator (https://rmqr.oudon.xyz/) only has Japanese version, but I think it is good to support other languages (at least English version) if you want non-Japanese people to use it.

Type hinting

Some versions code are can't be recognized by QRQR

The codes that generated this library with version R7x77, R7x139, R9x59, R9x99, R11x43, R11x77, R11x139, R13x27, R15x99, R15x139 are could not be recognized with QRQR.

to Reproduce

1. $ rmqr nasubi out.png --version R7x77
2. scan out.png with QRQR

Version

• rmqrcode: 0.3.1
• QRQR for iOS: 3.0.29

Move from DataCapacities to rMQRVersions