qr

Documentation

Overview

Package qr implements the creation of QR code based Apple HomeKit® setup codes and the respective payloads.

Index

• func CreateBoxedCode(setupCode hk.Code, setupID hk.ID, setupFlags hk.Flag, category hk.Category) (image.Image, error)
• func CreateCode(setupCode hk.Code, setupID hk.ID, setupFlags hk.Flag, category hk.Category) (image.Image, error)
• func CreatePayload(setupCode hk.Code, setupID hk.ID, setupFlags hk.Flag, category hk.Category) (string, error)

Functions

func CreateBoxedCode

func CreateBoxedCode(setupCode hk.Code, setupID hk.ID, setupFlags hk.Flag, category hk.Category) (image.Image, error)

CreateBoxedCode creates a QR code based Apple HomeKit® setup code that is placed inside a bordered box with the Apple HomeKit® logo and the setup code in plain text. These codes are usually found as stickers on MFi accessories.

func CreateCode

func CreateCode(setupCode hk.Code, setupID hk.ID, setupFlags hk.Flag, category hk.Category) (image.Image, error)

CreateCode creates a QR code based Apple HomeKit® setup code.

func CreatePayload

func CreatePayload(setupCode hk.Code, setupID hk.ID, setupFlags hk.Flag, category hk.Category) (string, error)

CreatePayload creates a QR code payload for the given Apple HomeKit® setup code.