skyalert

README

Sky Alert

Go bindings to read and parse data from the SkyAlert from Interactive Astronomy

Product Description:

SkyAlert is a self-contained weather monitoring system designed for
automated observatories. SkyAlert monitors wind, humidity, rain, 
temperature, daylight, dew point and cloud conditions and uses the 
data to create a standard one-line weather data file that can be 
used by most image automation software packages and observatory 
roof control systems. The included software can produce custom 
real-time weather graphs and generate jpeg or png format snapshot 
images of the graphs which can be uploaded to the web via the 
built-in ftp client. The software package also includes SkyAlert 
Remote, which can be used for remote location installations.

Documentation

Index

• Constants
• type AlertCondition
• type CloudCondition
• type DarknessCondition
• type Data
  • func New(in []byte) *Data
  • func (d *Data) Parse() (*Data, error)
  • func (d *Data) WithLocation(loc *time.Location) *Data
• type RainCondition
• type WindCondition

Constants

const (
	// Clouds
	CloudUnknown     CloudCondition = 0
	CloudClear       CloudCondition = 1
	CloudLightClouds CloudCondition = 2
	CloudVeryCloudy  CloudCondition = 3
	CloudDisabled    CloudCondition = 4

	// WindLimit
	WindUnknown   WindCondition = 0
	WindCalm      WindCondition = 1
	WindWindy     WindCondition = 2
	WindVeryWindy WindCondition = 3
	WindDisabled  WindCondition = 4

	// RainFlag
	RainUnknown  RainCondition = 0
	RainDry      RainCondition = 1
	RainDamp     RainCondition = 2
	RainRain     RainCondition = 3
	RainDisabled RainCondition = 4

	// Darkness
	DarknessUnknown   DarknessCondition = 0
	DarknessDark      DarknessCondition = 1
	DarknessLight     DarknessCondition = 2
	DarknessVeryLight DarknessCondition = 3
	DarknessDisabled  DarknessCondition = 4

	// Alert
	NoWeatherAlert AlertCondition = 0
	WeatherAlert   AlertCondition = 1
)

Types

type AlertCondition

type AlertCondition int

type CloudCondition

type CloudCondition int

type DarknessCondition

type DarknessCondition int

type Data

type Data struct {
	Timestamp           time.Time         `json:"timestamp" yaml:"timestamp" xml:"timestamp"`                               // 2024-06-11 14:09:57.00
	TempScale           string            `json:"tempScale" yaml:"tempScale" xml:"tempScale"`                               // F
	WindScale           string            `json:"windScale" yaml:"windScale" xml:"windScale"`                               // M
	SkyTemp             float64           `json:"skyTemp" yaml:"skyTemp" xml:"skyTemp"`                                     // 79.6
	AmbientTemp         float64           `json:"ambientTemp" yaml:"ambientTemp" xml:"ambientTemp"`                         // 92.8
	SensorTemp          float64           `json:"sensorTemp" yaml:"sensorTemp" xml:"sensorTemp"`                            // 93
	WindSpeed           float64           `json:"windSpeed" yaml:"windSpeed" xml:"windSpeed"`                               // 0
	Humidity            int               `json:"humidity" yaml:"humidity" xml:"humidity"`                                  // 42
	DewPoint            float64           `json:"dewPoint" yaml:"dewPoint" xml:"dewPoint"`                                  // 66.3
	DewHeaterPercentage int               `json:"dewHeaterPercentage" yaml:"dewHeaterPercentage" xml:"dewHeaterPercentage"` // 000
	RainFlag            int               `json:"rainFlag" yaml:"rainFlag" xml:"rainFlag"`                                  // 0
	WetFlag             int               `json:"wetFlag" yaml:"wetFlag" xml:"wetFlag"`                                     // 0
	SinceGoodData       int               `json:"secSinceGoodData" yaml:"secSinceGoodData" xml:"secSinceGoodData"`          // 00019
	DaysSinceLastWrite  float64           `json:"daysSinceLastWrite" yaml:"daysSinceLastWrite" xml:"daysSinceLastWrite"`    // 045454.59025
	CloudCondition      CloudCondition    `json:"cloudCondition" yaml:"cloudCondition" xml:"cloudCondition"`                // 3
	WindCondition       WindCondition     `json:"windCondition" yaml:"windCondition" xml:"windCondition"`                   // 1
	RainCondition       RainCondition     `json:"rainCondition" yaml:"rainCondition" xml:"rainCondition"`                   // 1
	DarknessCondition   DarknessCondition `json:"darknessCondition" yaml:"darknessCondition" xml:"darknessCondition"`       // 1
	RoofCloseRequested  int               `json:"roofCloseRequested" yaml:"roofCloseRequested" xml:"roofCloseRequested"`    // 1
	AlertCondition      AlertCondition    `json:"alertCondition" yaml:"alertCondition" xml:"alertCondition"`                // 1

	// used internally to create SinceGoodData
	GeneratedAt time.Time `json:"-" yaml:"-" xml:"-"`
	// contains filtered or unexported fields
}

The SkyAlert adheres to the the Boltwood II cloud sensor standard.

Following are the docs from SBIG.

https://diffractionlimited.com/wp-content/uploads/2016/04/Cloud-SensorII-Users-Manual.pdf

+====+==========+============+====================================================+ | | Heading | Col’s | Meaning | |====|==========|============|====================================================| | 0 | Date | 1-10 | local date yyyy-mm-dd | |----|----------|------------|----------------------------------------------------| | 1 | Time | 12-22 | local time hh:mm:ss.ss (24 hour clock) | |----|----------|------------|----------------------------------------------------| | 2 | T | 24 | temperature units displayed and in this | | | | | data, 'C' for Celsius or 'F' for Fahrenheit | |----|----------|------------|----------------------------------------------------| | 3 | V | 26 | wind velocity units displayed and in this | | | | | data, 'K' for km/hr or 'M' for mph or 'm' for m/s | |----|----------|------------|----------------------------------------------------| | 4 | SkyT | 28-33 | sky-ambient temperature | |----|----------|------------|----------------------------------------------------| | 5 | AmbT | 35-40 | ambient temperature | |----|----------|------------|----------------------------------------------------| | 6 | SenT | 41-47 | sensor case temperature | |----|----------|------------|----------------------------------------------------| | 7 | Wind | 49-54 | wind speed | |----|----------|------------|----------------------------------------------------| | 8 | Hum | 56-58 | relative humidity in % | |----|----------|------------|----------------------------------------------------| | 9 | DewPt | 60-65 | dew point temperature | |----|----------|------------|----------------------------------------------------| | 10 | Hea | 67-69 | heater setting in % | |----|----------|------------|----------------------------------------------------| | 11 | R | 71 | rain flag (0=dry, 1=rain last minute, 2=rain now) | |----|----------|------------|----------------------------------------------------| | 12 | W | 73 | wet flag (0=dry, 1=wet last minute, 2=wet now) | |----|----------|------------|----------------------------------------------------| | 13 | Since | 75-79 | seconds since the last valid data | |----|----------|------------|----------------------------------------------------| | 14 | Now() | 81-92 | date/time given as the VB6 Now() function result | | | | | (in days) when Clarity II last wrote this file | |----|----------|------------|----------------------------------------------------| | 15 | c | 94 | cloud condition | | | | | 0=unknown, 1=clear, 2=cloudy, 3=veryCloudy | |----|----------|------------|----------------------------------------------------| | 16 | w | 96 | wind condition | | | | | 0=unknown, 1=calm, 2=windy, 3=veryWindy | |----|----------|------------|----------------------------------------------------| | 17 | r | 98 | rain condition | | | | | 0=unknown, 1=dry, 2=wet, 3=rain | |----|----------|------------|----------------------------------------------------| | 18 | d | 100 | daylight condition | | | | | 0=unknown, 1=dark, 2=light, 3=verylight | |----|----------|------------|----------------------------------------------------| | 19 | C | 102 | roof close, =0 not requested, =1 close requested | |----|----------|------------|----------------------------------------------------| | 20 | A | 104 | alert, =0 when not alerting, =1 when alerting | +----+----------+------------+----------------------------------------------------+

Sample when the unit was sitting on my server rack:
2024-06-11 14:09:57.00 F M 79.6   92.8  93      0      42  66.3   000 0 0 00019 045454.59025 3 1 1 1 1 1

func New

func New(in []byte) *Data

Generates a new Data struct from an io.reader. See the examples directory

func (*Data) Parse

func (d *Data) Parse() (*Data, error)

Parse handles parsing the read one-line data file into the Data struct

func (*Data) WithLocation

func (d *Data) WithLocation(loc *time.Location) *Data

WithLocation Sets a non-local location for time parsing

One probably is running this on a server in the same rack or a small raspberry pi that has the same timezone as is set on the SkyAlert. By default, this assumes a local timezone, but can be overridden with this function.

type RainCondition

type RainCondition int

type WindCondition

type WindCondition int