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 WithQuiteZone(n int) EncodeOptions
• type Level
  • func (lv Level) String() string
• type Mask
• 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

Functions

func Encode

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

Types

type EncodeOptions

type EncodeOptions interface {
	// contains filtered or unexported methods
}

func WithKanji

func WithKanji(use bool) EncodeOptions

func WithLevel

func WithLevel(lv Level) EncodeOptions

func WithModuleSize

func WithModuleSize(size float64) EncodeOptions

func WithQuiteZone

func WithQuiteZone(n int) EncodeOptions

type Level

type Level int

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

func (Level) String

func (lv Level) String() string

type Mask

type Mask int

const (
	Mask0 Mask = iota
	Mask1
	Mask2
	Mask3
	Mask4
	Mask5
	Mask6
	Mask7

	MaskAuto Mask = -1
)

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