userdb

README

Library for building userdb files for MD-380/MD-UV380 radios.

This library provides a go API for building MD-380 (and other DMR radios) userdb files.

Author

Dale Farnsworth

dale@farnsworth.org

IRC: libera.chat channel: #md380, user: dfarnsworth

Documentation

Index

• Constants
• type DBOption
  • func Abbreviate(b bool) DBOption
  • func AbbreviateCountries(b bool) DBOption
  • func AbbreviateDirections(b bool) DBOption
  • func AbbreviateStates(b bool) DBOption
  • func CheckTitleCase(b bool) DBOption
  • func CuratedUsers() DBOption
  • func FilterByCountries(countries ...string) DBOption
  • func FixRomanNumerals(b bool) DBOption
  • func FixStateCountries(b bool) DBOption
  • func FromFile(path string) DBOption
  • func MergeNewUsers() DBOption
  • func MiscFixes(b bool) DBOption
  • func RemoveCallFromNickname(b bool) DBOption
  • func RemoveMatchingNickname(b bool) DBOption
  • func RemoveRepeatedSurnames(b bool) DBOption
  • func RemoveRepeats(b bool) DBOption
  • func TitleCase(b bool) DBOption
• type RadioidTop
• type RadioidUser
• type User
• type UsersDB
  • func New(opts ...DBOption) (*UsersDB, error)
  • func (db *UsersDB) AllCountries() ([]string, error)
  • func (db *UsersDB) MD380String() string
  • func (db *UsersDB) SetOptions(opts ...DBOption)
  • func (db *UsersDB) SetProgressCallback(fcn func(int) error)
  • func (db *UsersDB) UV380Image() []byte
  • func (db *UsersDB) Users() []*User
  • func (db *UsersDB) WriteMD380ToolsFile(filename string) error

Constants

const (
	MinProgress = 0
	MaxProgress = 1000000
)

Minimum and maximum vallues of the progress counter

const (
	MaxUV380Users = 122197
)

Types

type DBOption

type DBOption func(db *UsersDB)

func Abbreviate

func Abbreviate(b bool) DBOption

func AbbreviateCountries

func AbbreviateCountries(b bool) DBOption

func AbbreviateDirections

func AbbreviateDirections(b bool) DBOption

func AbbreviateStates

func AbbreviateStates(b bool) DBOption

func CheckTitleCase

func CheckTitleCase(b bool) DBOption

func CuratedUsers

func CuratedUsers() DBOption

func FilterByCountries

func FilterByCountries(countries ...string) DBOption

func FixRomanNumerals

func FixRomanNumerals(b bool) DBOption

func FixStateCountries

func FixStateCountries(b bool) DBOption

func FromFile

func FromFile(path string) DBOption

func MergeNewUsers

func MergeNewUsers() DBOption

func MiscFixes

func MiscFixes(b bool) DBOption

func RemoveCallFromNickname

func RemoveCallFromNickname(b bool) DBOption

func RemoveMatchingNickname

func RemoveMatchingNickname(b bool) DBOption

func RemoveRepeatedSurnames

func RemoveRepeatedSurnames(b bool) DBOption

func RemoveRepeats

func RemoveRepeats(b bool) DBOption

func TitleCase

func TitleCase(b bool) DBOption

type RadioidTop

type RadioidTop struct {
	RadioidUsers []*RadioidUser `json:"users"`
}

type RadioidUser

type RadioidUser struct {
	ID       int    `json:"radio_id"`
	Callsign string `json:"callsign"`
	Name     string `json:"name"`
	Surname  string `json:"surname"`
	City     string `json:"city"`
	State    string `json:"state"`
	Country  string `json:"country"`
}

type User

type User struct {
	ID       int
	Callsign string
	Name     string
	City     string
	State    string
	Nickname string
	Country  string
	// contains filtered or unexported fields
}

User - A structure holding information about a user in the databae

type UsersDB

type UsersDB struct {
	// contains filtered or unexported fields
}

UsersDB - A structure holding information about the database of DMR users

func New

func New(opts ...DBOption) (*UsersDB, error)

New Users DB - Instantiate a new users db and (by default) download curated users

func (*UsersDB) AllCountries

func (db *UsersDB) AllCountries() ([]string, error)

func (*UsersDB) MD380String

func (db *UsersDB) MD380String() string

func (*UsersDB) SetOptions

func (db *UsersDB) SetOptions(opts ...DBOption)

func (*UsersDB) SetProgressCallback

func (db *UsersDB) SetProgressCallback(fcn func(int) error)

SetProgressCallback - Set callback function for progress of db operations.

func (*UsersDB) UV380Image

func (db *UsersDB) UV380Image() []byte

func (*UsersDB) Users

func (db *UsersDB) Users() []*User

Users - Return the, possibly filtered, current list of DMR users

func (*UsersDB) WriteMD380ToolsFile

func (db *UsersDB) WriteMD380ToolsFile(filename string) error

WriteMD380ToolsFile - Write a user db file in MD380 format