qrcode

README

qrcode

QR code, Micro QR code and Rectangular Micro QR Code (rMQR) encoder.

REFERENCE

• http://en.wikipedia.org/wiki/QR_code
• JIS X 0510 : 2018 技術情報 - 自動認識及びデータ取得技術 - QRコード バーコードシンボル体系仕様
• Rectangular Micro QR Code (rMQR) bar code symbology specification: ISO/IEC 23941
• rMQR Code | QRcode.com | DENSO WAVE

RELATED WORKS

• skip2/go-qrcode
• OUDON/rmqrcode-python

Documentation

Index

• func Encode(data []byte, opts ...EncodeOptions) (image.Image, error)
• type EncodeOptions
  • func WithKanji(use bool) EncodeOptions
  • func WithLevel(lv Level) EncodeOptions
  • func WithModuleSize(size float64) EncodeOptions
  • func WithQuietZone(n int) EncodeOptions
  • func WithWidth(width int) EncodeOptions
• type Level
  • func (lv Level) IsValid() bool
  • func (lv Level) String() string
• type Mask
  • func (m Mask) IsValid() bool
• type Mode
  • func (mode Mode) String() string
• type QRCode
  • func DecodeBitmap(img *bitmap.Image) (*QRCode, error)
  • func New(data []byte, opts ...EncodeOptions) (*QRCode, error)
  • func (qr *QRCode) Encode(opts ...EncodeOptions) (image.Image, error)
  • func (qr *QRCode) EncodeToBitmap() (*bitmap.Image, error)
• type Segment
• type Version
  • func (v Version) IsValid() bool

Functions

func Encode

func Encode(data []byte, opts ...EncodeOptions) (image.Image, error)

Types

type EncodeOptions

type EncodeOptions func(opts *encodeOptions)

func WithKanji

func WithKanji(use bool) EncodeOptions

WithKanji sets the kanji mode. The default mode is true. If it's enabled, Shift-JIS encoding is used for kanji mode.

func WithLevel

func WithLevel(lv Level) EncodeOptions

WithLevel sets the error correction level. The default level is LevelM. If the level is invalid, it panics.

func WithModuleSize

func WithModuleSize(size float64) EncodeOptions

WithModuleSize sets the module size. The default size is 1.

func WithQuietZone

func WithQuietZone(n int) EncodeOptions

WithQuietZone sets the quiet zone size. The default size is 4.

func WithWidth

func WithWidth(width int) EncodeOptions

WithWidth sets the width of the image. The larger of the image width calculated from WithModuleSize and the image width specified with WithWidth is used.

type Level

type Level int

Level is a error correction level.

const (
	LevelL Level = 0b01
	LevelM Level = 0b00
	LevelQ Level = 0b11
	LevelH Level = 0b10
)

func (Level) IsValid

func (lv Level) IsValid() bool

IsValid returns true if the level is valid.

func (Level) String

func (lv Level) String() string

type Mask

type Mask int

Mask is a mask pattern.

const (
	Mask0 Mask = 0b000
	Mask1 Mask = 0b001
	Mask2 Mask = 0b010
	Mask3 Mask = 0b011
	Mask4 Mask = 0b100
	Mask5 Mask = 0b101
	Mask6 Mask = 0b110
	Mask7 Mask = 0b111

	MaskAuto Mask = -1
)

func (Mask) IsValid

func (m Mask) IsValid() bool

IsValid returns true if the mask is valid.

type Mode

type Mode uint8

const (
	// ModeECI is ECI(Extended Channel Interpretation) mode.
	ModeECI Mode = 0b0111

	// ModeNumeric is number mode.
	// The Data must be ascii characters [0-9].
	ModeNumeric Mode = 0b0001

	// ModeAlphanumeric is alphabet and number mode.
	// The Data must be ascii characters [0-9A-Z $%*+\-./:].
	ModeAlphanumeric Mode = 0b0010

	// ModeBytes is 8-bit bytes mode.
	// The Data can include any bytes.
	ModeBytes Mode = 0b0100

	// ModeKanji is Japanese Kanji mode.
	ModeKanji Mode = 0b1000

	// ModeConnected is connected structure mode.
	ModeConnected Mode = 0b0011

	ModeFNC1_1 Mode = 0b0101
	ModeFNC1_2 Mode = 0b1001

	ModeTerminated Mode = 0b0000
)

func (Mode) String

func (mode Mode) String() string

type QRCode

type QRCode struct {
	Version  Version
	Level    Level
	Mask     Mask
	Segments []Segment
}

func DecodeBitmap

func DecodeBitmap(img *bitmap.Image) (*QRCode, error)

func New

func New(data []byte, opts ...EncodeOptions) (*QRCode, error)

func (*QRCode) Encode

func (qr *QRCode) Encode(opts ...EncodeOptions) (image.Image, error)

func (*QRCode) EncodeToBitmap

func (qr *QRCode) EncodeToBitmap() (*bitmap.Image, error)

EncodeToBitmap encodes QR Code into bitmap image.

type Segment

type Segment struct {
	Mode Mode
	Data []byte
}

type Version

type Version int

Version is a version of QR code.

func (Version) IsValid

func (v Version) IsValid() bool