beerxml

package
v0.0.0-...-f683377 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 5, 2019 License: GPL-3.0 Imports: 5 Imported by: 0

Documentation

Overview

Implements the BeerXML standard used to exchange and represent brewing data. Do not support extensions. See http://www.beerxml.com

Index

Constants

View Source 
const (
	LToGallon = 0.264172
	KgToPound = 2.20462
	KgToOunce = 35.274
	SrmToEbc  = 1.97
)

Variables

View Source 
var SrmHex = map[float64]struct {
	R, G, B int

}{}/* 400 elements not displayed */

Srm to hex color map. https://www.barleydogbrewery.com/xml/colors.xml — Copyleft license.

Functions

func Export 

func Export(data interface{}, w io.Writer) error

func ExportFile 

func ExportFile(data interface{}, file string) error

Write a BeerXML object to a file.

func Import 

func Import(r io.Reader, data interface{}) error

func ImportFile 

func ImportFile(file string, data interface{}) error

Open a Beer XML formated file and returns a BeerXML object.

func InsertToRecipe 

func InsertToRecipe(recipe *Recipe, e interface{}) error

Insert a recipe element into a Recipe object.

func InsertToXML 

func InsertToXML(xml *BeerXML, e interface{}) error

Insert an element into a BeerXML object.

func RemoveFromRecipe 

func RemoveFromRecipe(recipe *Recipe, e interface{}, key int) error

Remove a recipe element from a recipe object.

Types

type BeerXML 

type BeerXML struct {
	Hops         []Hop         `xml:"HOPS>HOP"`
	Fermentables []Fermentable `xml:"FERMENTABLES>FERMENTABLE"`
	Yeasts       []Yeast       `xml:"YEASTS>YEAST"`
	Miscs        []Misc        `xml:"MISCS>MISC"`
	Waters       []Water       `xml:"WATERS>WATER"`
	Equipments   []Equipment   `xml:"EQUIPMENTS>EQUIPMENT"`
	Styles       []Style       `xml:"STYLES>STYLE"`
	MashSteps    []MashStep    `xml:"MASH_STEPS>MASH_STEP"`
	Mashs        []Mash        `xml:"MASHS>MASH"`
	Recipes      []Recipe      `xml:"RECIPES>RECIPE"`
}

type Equipment 

type Equipment struct {
	Name            string  `xml:"NAME"`
	Version         int32   `xml:"VERSION"`
	BoilSize        float64 `xml:"BOIL_SIZE"`
	BatchSize       float64 `xml:"BATCH_SIZE"`
	TunVolume       float64 `xml:"TUN_VOLUME"`
	TunWeight       float64 `xml:"TUN_WEIGHT"`
	TunSpecificHeat float64 `xml:"TUN_SPECIFIC_HEAT"`
	TopUpWater      float64 `xml:"TOP_UP_WATER"`
	TrubChillerLoss float64 `xml:"TRUB_CHILLER_LOSS"`
	EvapRate        float64 `xml:"EVAP_RATE"`
	BoilTime        float64 `xml:"BOIL_TIME"`
	CalcBoilVolume  bool    `xml:"CALC_BOIL_VOLUME"`
	LauterDeadspace float64 `xml:"LAUTER_DEADSPACE"`
	TopUpKettle     float64 `xml:"TOP_UP_KETTLE"`
	HopUtilization  float64 `xml:"HOP_UTILIZATION"`
	Notes           string  `xml:"NOTES"`
	/* Extensions */
	DisplayBoilSize        string `xml:"DISPLAY_BOIL_SIZE"`
	DisplayBatchSize       string `xml:"DISPLAY_BATCH_SIZE"`
	DisplayTunVolume       string `xml:"DISPLAY_TUN_VOLUME"`
	DisplayTunWeight       string `xml:"DISPLAY_TUN_WEIGHT"`
	DisplayTopUpWater      string `xml:"DISPLAY_TOP_UP_WATER"`
	DisplayTrubChillerLoss string `xml:"DISPLAY_TRUB_CHILLER_LOSS"`
	DisplayLauterDeadspace string `xml:"DISPLAY_LAUTER_DEADSPACE"`
	DisplayTopUpKettle     string `xml:"DISPLAY_TOP_UP_KETTLE"`
}

type Fermentable 

type Fermentable struct {
	Name           string  `xml:"NAME"`
	Version        int32   `xml:"VERSION"`
	Type           string  `xml:"TYPE"`
	Amount         float64 `xml:"AMOUNT"`
	Yield          float64 `xml:"YIELD"`
	Color          float64 `xml:"COLOR"`
	AddAfterBoil   bool    `xml:"ADD_AFTER_BOIL"`
	Origin         string  `xml:"ORIGIN"`
	Supplier       string  `xml:"SUPPLIER"`
	Notes          string  `xml:"NOTES"`
	CoarseFineDiff float64 `xml:"COARSE_FINE_DIFF"`
	Moisture       float64 `xml:"MOISTURE"`
	DiastaticPower float64 `xml:"DIASTATIC_POWER"`
	Protein        float64 `xml:"PROTEIN"`
	MaxInBatch     float64 `xml:"MAX_IN_BATCH"`
	RecommendMash  bool    `xml:"RECOMMEND_MASH"`
	IbuGalPerLb    float64 `xml:"IBU_GAL_PER_LB"`
	/* Extensions */
	DisplayAmount string  `xml:"DISPLAY_AMOUNT"`
	Potential     float64 `xml:"POTENTIAL"`
	Inventory     string  `xml:"INVENTORY"`
	DisplayColor  string  `xml:"DISPLAY_COLOR"`
}

type Hop 

type Hop struct {
	Name          string  `xml:"NAME"`
	Version       int32   `xml:"VERSION"`
	Alpha         float64 `xml:"ALPHA"`
	Amount        float64 `xml:"AMOUNT"`
	Use           string  `xml:"USE"`
	Time          float64 `xml:"TIME"`
	Notes         string  `xml:"NOTES"`
	Type          string  `xml:"TYPE"`
	Form          string  `xml:"FORM"`
	Beta          float64 `xml:"BETA"`
	Hsi           float64 `xml:"HSI"`
	Origin        string  `xml:"ORIGIN"`
	Substitutes   string  `xml:"SUBSTITUTES"`
	Humulene      float64 `xml:"HUMULENES"`
	Caryophyllene float64 `xml:"CARYOPHYLLENE"`
	Cohumulone    float64 `xml:"COHUMULONE"`
	Myrcene       float64 `xml:"MYRCENE"`
	/* Extensions */
	DisplayAmount string `xml:"DISPLAY_AMOUNT"`
	Inventory     string `xml:"INVENTORY"`
	DisplayTime   string `xml:"DISPLAY_TIME"`
}

type Mash 

type Mash struct {
	Name            string     `xml:"NAME"`
	Version         int32      `xml:"VERSION"`
	GrainTemp       float64    `xml:"GRAIN_TEMP"`
	MashSteps       []MashStep `xml:"MASH_STEPS>MASH_STEP"`
	Notes           string     `xml:"NOTES"`
	TunTemp         float64    `xml:"TUN_TEMP"`
	SpargeTemp      float64    `xml:"SPARGE_TEMP"`
	Ph              float64    `xml:"PH"`
	TunWeight       float64    `xml:"TUN_WEIGHT"`
	TunSpecificHeat float64    `xml:"TUN_SPECIFIC_HEAT"`
	EquipAdjust     bool       `xml:"EQUIP_ADJUST"`
	/* Extensions */
	DisplayGrainTemp  string `xml:"DISPLAY_GRAIN_TEMP"`
	DisplayTunTemp    string `xml:"DISPLAY_TUN_TEMP"`
	DisplaySpargeTemp string `xml:"DISPLAY_SPARGE_TEMP"`
	DisplayTunWeight  string `xml:"DISPLAY_TUN_WEIGHT"`
}

type MashStep 

type MashStep struct {
	Name         string  `xml:"NAME"`
	Version      int32   `xml:"VERSION"`
	Type         string  `xml:"TYPE"`
	InfuseAmount float64 `xml:"INFUSE_AMOUNT"`
	StepTemp     float64 `xml:"STEP_TEMP"`
	StepTime     float64 `xml:"STEP_TIME"`
	RampTime     float64 `xml:"RAMP_TIME"`
	EndTemp      float64 `xml:"END_TEMP"`
	/* Extensions */
	Description      string `xml:"DESCRIPTION"`
	WaterGrainRatio  string `xml:"WATER_GRAIN_RATIO"`
	DecoctionAmt     string `xml:"DECOCTION_AMT"`
	InfuseTemp       string `xml:"INFUSE_TEMP"`
	DisplayStepTemp  string `xml:"DISPLAY_STEP_TEMP"`
	DisplayInfuseAmt string `xml:"DISPLAY_INFUSE_AMOUNT"`
}

type Misc 

type Misc struct {
	Name           string  `xml:"NAME"`
	Version        int32   `xml:"VERSION"`
	Type           string  `xml:"TYPE"`
	Use            string  `xml:"USE"`
	Time           float64 `xml:"TIME"`
	Amount         float64 `xml:"AMOUNT"`
	AmountIsWeight bool    `xml:"AMOUNT_IS_WEIGHT"`
	UseFor         string  `xml:"USE_FOR"`
	Notes          string  `xml:"NOTES"`
	/* Extensions */
	DisplayAmount string `xml:"DISPLAY_AMOUNT"`
	Inventory     string `xml:"INVENTORY"`
	DisplayTime   string `xml:"DISPLAY_TIME"`
}

type Recipe 

type Recipe struct {
	Name               string        `xml:"NAME"`
	Version            int32         `xml:"VERSION"`
	Type               string        `xml:"TYPE"`
	Style              Style         `xml:"STYLE"`
	Equipment          Equipment     `xml:"EQUIPMENT"`
	Brewer             string        `xml:"BREWER"`
	AsstBrewer         string        `xml:"ASST_BREWER"`
	BatchSize          float64       `xml:"BATCH_SIZE"`
	BoilSize           float64       `xml:"BOIL_SIZE"`
	BoilTime           float64       `xml:"BOIL_TIME"`
	Efficiency         float64       `xml:"EFFICIENCY"`
	Hops               []Hop         `xml:"HOPS>HOP"`
	Fermentables       []Fermentable `xml:"FERMENTABLES>FERMENTABLE"`
	Miscs              []Misc        `xml:"MISCS>MISC"`
	Yeasts             []Yeast       `xml:"YEASTS>YEAST"`
	Waters             []Water       `xml:"WATERS>WATER"`
	Mash               Mash          `xml:"MASH"`
	Notes              string        `xml:"NOTES"`
	TasteNotes         string        `xml:"TASTE_NOTES"`
	TasteRating        float64       `xml:"TASTE_RATING"`
	OG                 float64       `xml:"OG"`
	FG                 float64       `xml:"FG"`
	FermentationStages int32         `xml:"FERMENTATION_STAGES"`
	PrimaryAge         float64       `xml:"PRIMARY_AGE"`
	PrimaryTemp        float64       `xml:"PRIMARY_TEMP"`
	SecondaryAge       float64       `xml:"SECONDARY_AGE"`
	SecondaryTemp      float64       `xml:"SECONDARY_TEMP"`
	TertiaryAge        float64       `xml:"TERTIARY_AGE"`
	TertiaryTemp       float64       `xml:"TERTIARY_TEMP"`
	Age                float64       `xml:"AGE"`
	AgeTemp            float64       `xml:"AGE_TEMP"`
	Date               string        `xml:"DATE"`
	Carbonation        float64       `xml:"CARBONATION"`
	ForcedCarbonation  bool          `xml:"FORCED_CARBONATION"`
	PrimingSugarName   string        `xml:"PRIMING_SUGAR_NAME"`
	CarbonationTemp    float64       `xml:"CARBONATIOn_TEMP"`
	PrimingSugarEquiv  float64       `xml:"PRIMING_SUGAR_EQUIV"`
	KegPrimingFactor   float64       `xml:"KEG_PRIMING_FACTOR"`
	/* Extensions */
	EstOG            float64 `xml:"EST_OG"`
	EstFG            float64 `xml:"EST_FG"`
	EstColor         float64 `xml:"EST_COLOR"`
	IBU              float64 `xml:"IBU"`
	EstABV           float64 `xml:"EST_ABV"`
	ABV              float64 `xml:"ABV"`
	ActualEfficiency float64 `xml:"ACTUAL_EFFICIENCY"`
	Calories         float64 `xml:"CALORIES"`
}

func (*Recipe) CalcABV 

func (r *Recipe) CalcABV() float64

Compute the estimated alcohol by volume, using estimated OG and FG.

func (*Recipe) CalcBoilSize 

func (r *Recipe) CalcBoilSize() float64

Compute the volume needed before boiling.

func (*Recipe) CalcColor 

func (r *Recipe) CalcColor() float64

Compute the color (SRM). https://www.brassageamateur.com/wiki/index.php/Formules#Couleur_de_la_bi.C3.A8re

func (*Recipe) CalcFG 

func (r *Recipe) CalcFG() float64

Compute the final gravity. https://www.brassageamateur.com/wiki/index.php/Formules#Densit.C3.A9_finale_th.C3.A9orique

func (*Recipe) CalcIBU 

func (r *Recipe) CalcIBU() float64

Compute the bitterness using the Tinseth formula. https://www.brassageamateur.com/wiki/index.php/Formules#Amertume_objective_de_la_bi.C3.A8re

func (*Recipe) CalcIbuOg 

func (r *Recipe) CalcIbuOg() float64

Compute the BU:GU ratio. https://www.brassageamateur.com/wiki/index.php/Formules#Amertume_subjective

func (*Recipe) CalcIbuRe 

func (r *Recipe) CalcIbuRe() float64

Compute the IBU:RE ratio. https://www.brassageamateur.com/wiki/index.php/Formules#Amertume_subjective

func (*Recipe) CalcOG 

func (r *Recipe) CalcOG() float64

Compute the original gravity. The gravity is the density of a liquid compared to that of water (1). https://www.brassageamateur.com/wiki/index.php/Formules#Densit.C3.A9_pr.C3.A9-.C3.A9bullition_selon_grain

func (*Recipe) CalcRealABV 

func (r *Recipe) CalcRealABV() float64

Compute the estimated alcohol by volume, using the real OG and FG.

func (*Recipe) CalcVolumeTot 

func (r *Recipe) CalcVolumeTot() float64

Compute the volume needed in total.

type Style 

type Style struct {
	Name           string  `xml:"NAME"`
	Category       string  `xml:"CATEGORY"`
	Version        int32   `xml:"VERSION"`
	CategoryNumber string  `xml:"CATEGORY_NUMBER"`
	StyleLetter    string  `xml:"STYLE_LETTER"`
	StyleGuide     string  `xml:"STYLE_GUIDE"`
	Type           string  `xml:"TYPE"`
	OgMin          float64 `xml:"OG_MIN"`
	OgMax          float64 `xml:"OG_MAX"`
	FgMin          float64 `xml:"FG_MIN"`
	FgMax          float64 `xml:"FG_MAX"`
	IbuMin         float64 `xml:"IBU_MIN"`
	IbuMax         float64 `xml:"IBU_MAX"`
	ColorMin       float64 `xml:"COLOR_MIN"`
	ColorMax       float64 `xml:"COLOR_MAX"`
	CarbMin        float64 `xml:"CARB_MIN"`
	CarbMax        float64 `xml:"CARB_MAX"`
	AbvMax         float64 `xml:"ABV_MAX"`
	AbvMin         float64 `xml:"ABV_MIN"`
	Notes          string  `xml:"NOTES"`
	Profile        string  `xml:"PROFILE"`
	Ingredients    string  `xml:"INGREDIENTS"`
	Examples       string  `xml:"EXAMPLES"`
	/* Extensions */
	DisplayOgMin    string `xml:"DISPLAY_OG_MIN"`
	DisplayOgMax    string `xml:"DISPLAY_OG_MAX"`
	DisplayFgMin    string `xml:"DISPLAY_FG_MIN"`
	DisplayFgMax    string `xml:"DISPLAY_FG_MAX"`
	DisplayColorMin string `xml:"DISPLAY_COLOR_MIN"`
	DisplayColorMax string `xml:"DISPLAY_COLOR_MAX"`
	OgRange         string `xml:"OG_RANGE"`
	FgRange         string `xml:"FG_RANGE"`
	IbuRange        string `xml:"IBU_RANGE"`
	CarbRange       string `xml:"CARB_RANGE"`
	ColorRange      string `xml:"COLOR_RANGE"`
	AbvRange        string `xml:"ABV_RANGE"`
}

type Water 

type Water struct {
	Name        string  `xml:"NAME"`
	Version     int32   `xml:"VERSION"`
	Amount      float64 `xml:"AMOUNT"`
	Calcium     float64 `xml:"CALCIUM"`
	Bicarbonate float64 `xml:"BICARBONATE"`
	Sulfate     float64 `xml:"SULFATE"`
	Chloride    float64 `xml:"CHLORIDE"`
	Sodium      float64 `xml:"SODIUM"`
	Magnesium   float64 `xml:"MAGNESIUM"`
	Ph          float64 `xml:"PH"`
	Notes       string  `xml:"NOTES"`
	/* Extensions */
	DisplayAmount string `xml:"DISPLAY_AMOUNT"`
}

type Yeast 

type Yeast struct {
	Name           string  `xml:"NAME"`
	Version        int32   `xml:"VERSION"`
	Type           string  `xml:"TYPE"`
	Form           string  `xml:"FORM"`
	Amount         float64 `xml:"AMOUNT"`
	AmountIsWeight bool    `xml:"AMOUNT_IS_WEIGHT"`
	Laboratory     string  `xml:"LABORATORY"`
	ProductId      string  `xml:"PRODUCT_ID"`
	MinTemperature float64 `xml:"MIN_TEMPERATURE"`
	MaxTemperature float64 `xml:"MAX_TEMPERATURE"`
	Flocculation   string  `xml:"FLOCCULATION"`
	Attenuation    float64 `xml:"ATTENUATION"`
	Notes          string  `xml:"NOTES"`
	BestFor        string  `xml:"BEST_FOR"`
	TimesCultured  int32   `xml:"TIMES_CULTURED"`
	MaxReuse       int32   `xml:"MAX_REUSE"`
	AddToSecondary bool    `xml:"ADD_TO_SECONDARY"`
	/* Extensions */
	DisplayAmount string `xml:"DISPLAY_AMOUNT"`
	DispMinTemp   string `xml:"DISP_MIN_TEMP"`
	DispMaxTemp   string `xml:"DISP_MAX_TEMP"`
	Inventory     string `xml:"INVENTORY"`
	CultureDate   string `xml:"CULTURE_DATE"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.