common

Documentation

Overview

Package common contains common functionality to firmware and bootloader of the bitbox02.

Index

• Constants
• type Product
  • func ProductFromDeviceProductString(productString string) (Product, error)

Constants

const (
	// FirmwareDeviceProductStringBitBox02Multi is the product string of the BitBox02 multi edition
	// firmware. It appears in the HID descriptor.
	FirmwareDeviceProductStringBitBox02Multi = "BitBox02"
	// FirmwareDeviceProductStringBitBox02BTCOnly is the product string of the BitBox02 btc-only
	// edition firmware. It appears in the HID descriptor.
	FirmwareDeviceProductStringBitBox02BTCOnly = "BitBox02BTC"

	// BootloaderDeviceProductStringBitBox02Multi is the product string of the BitBox02 multi
	// edition bootloader. It appears in the HID descriptor.
	BootloaderDeviceProductStringBitBox02Multi = "bb02-bootloader"
	// BootloaderDeviceProductStringBitBox02BTCOnly is the product string of the BitBox02 btc-only
	// edition bootloader. It appears in the HID descriptor.
	BootloaderDeviceProductStringBitBox02BTCOnly = "bb02btc-bootloader"

	// FirmwareDeviceProductStringBitBox02PlusMulti the product string of the "BitBox02 Plus" multi
	// edition firmware. It appears in the HID descriptor and the Bluetooth characteristic.
	FirmwareDeviceProductStringBitBox02PlusMulti = "bb02p-multi"
	// FirmwareDeviceProductStringBitBox02PlusBTCOnly is the product string of the "BitBox02 Plus"
	// btc-only edition firmware. It appears in the HID descriptor and the Bluetooth characteristic.
	FirmwareDeviceProductStringBitBox02PlusBTCOnly = "bb02p-btconly"

	// BootloaderDeviceProductStringBitBox02Multi is the product string of the "BitBox02 Plus" multi
	// edition bootloader. It appears in the HID descriptor and the Bluetooth characteristic.
	BootloaderDeviceProductStringBitBox02PlusMulti = "bb02p-bl-multi"
	// BootloaderDeviceProductStringBitBox02BTCOnly is the product string of the "BitBox02 Plus"
	// btc-only edition bootloader. It appears in the HID descriptor and the Bluetooth
	// characteristic.
	BootloaderDeviceProductStringBitBox02PlusBTCOnly = "bb02p-bl-btconly"
)

Types

type Product

type Product string

Product enumerates the BitBox-based products. A product is a "platform"-"edition" tuple. Together with the firmware version, it determines the device API.

const (
	// ProductBitBox02Multi is the multi (previously: standard) edition of the BitBox02.
	ProductBitBox02Multi Product = "bitbox02-multi"
	// ProductBitBox02BTCOnly is the btc-only edition of the BitBox02, restricting functionality to
	// Bitcoin.
	ProductBitBox02BTCOnly Product = "bitbox02-btconly"

	// ProductBitBox02PlusMulti is the multi edition of the BitBox02 Plus.
	ProductBitBox02PlusMulti Product = "bitbox02-plus-multi"
	// ProductBitBox02PlusBTCOnly is the btc-only edition of the BitBox02 Plus, restricting
	// functionality to Bitcoin.
	ProductBitBox02PlusBTCOnly Product = "bitbox02-plus-btconly"
)

func ProductFromDeviceProductString

func ProductFromDeviceProductString(productString string) (Product, error)

ProductFromDeviceProductString returns the firmware or bootloader product based on the usb Device product string. Returns an error for an invalid/unrecognized product string.