feat: improve effect parsing error handling

Author: mishamyrt

features/light/effect.go

@@ -2,6 +2,8 @@ package light
 
 import (
 	"math"
+
+	"github.com/pkg/errors"
 )
 
 // EffectParams represents keyboard effect parameters.
@@ -14,6 +16,23 @@ type EffectParams struct {
 	Brightness uint8 `json:"brightness"`
 }
 
+func NewEffectParams(color uint8, speed uint8, brightness uint8) (*EffectParams, error) {
+	if color > 7 {
+		return nil, errors.Wrap(ErrOutOfRange, "color")
+	}
+	if speed > 4 {
+		return nil, errors.Wrap(ErrOutOfRange, "speed")
+	}
+	if brightness > 4 {
+		return nil, errors.Wrap(ErrOutOfRange, "brightness")
+	}
+	return &EffectParams{
+		Color:      color,
+		Speed:      speed,
+		Brightness: brightness,
+	}, nil
+}
+
 // Effects represents keyboard effects state.
 type Effects struct {
 	Backlight BacklightEffect `json:"backlight"`
@@ -63,7 +82,10 @@ func (b *Effects) Bytes() []byte {
 }
 
 // ParseEffects parses raw bytes to effects struct.
-func ParseEffects(data []byte) *Effects {
+func ParseEffects(data []byte) (*Effects, error) {
+	if len(data) < 80 {
+		return nil, ErrOutOfBounds
+	}
 	result := &Effects{}
 	result.Debounce = data[2]
 	result.Sidelight = MiscEffect{
@@ -86,12 +108,25 @@ func ParseEffects(data []byte) *Effects {
 	result.Backlight.Params = make([]EffectParams, 29)
 	for i := range result.Backlight.Params {
 		offset := colorParamsOffset + (i * 2)
-		value := data[offset+1]
-		result.Backlight.Params[i] = EffectParams{
-			Color:      data[offset],
-			Speed:      uint8(math.Floor(float64(value) / 16)),
-			Brightness: value % 16,
+
+		if data[offset] == 255 {
+			continue
+		}
+		p := effectAppearance(data[offset+1])
+		_, err := NewEffectParams(data[offset], p.Speed(), p.Brightness())
+		if err != nil {
+			return nil, err
 		}
 	}
-	return result
+	return result, nil
+}
+
+type effectAppearance uint8
+
+func (e effectAppearance) Brightness() uint8 {
+	return uint8(math.Floor(float64(uint8(e)) / 16))
+}
+
+func (e effectAppearance) Speed() uint8 {
+	return uint8(e) % 16
 }

features/light/feature.go

@@ -49,7 +49,7 @@ func (f *Feature) GetEffects() (*Effects, error) {
 	if err != nil {
 		return nil, err
 	}
-	return ParseEffects(raw), err
+	return ParseEffects(raw)
 }
 
 // SetEffects sets keyboard effects.

features/light/state.go

@@ -41,7 +41,10 @@ func (s *StateData) Parse(tpl *layout.Template) (*State, error) {
 	if err != nil {
 		return nil, errors.Wrap(err, "colors")
 	}
-	effects := ParseEffects(s.Params)
+	effects, err := ParseEffects(s.Params)
+	if err != nil {
+		return nil, errors.Wrap(err, "effects")
+	}
 	var customEffect *CustomEffectMap
 	if tpl != nil {
 		custom, err := ParseCustomEffect(s.CustomEffect, tpl)

hid/deviceinfo.go

@@ -5,6 +5,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/mishamyrt/nuga-lib/device"
 	"github.com/sstallion/go-hid"
 )
 
@@ -16,7 +17,7 @@ var ErrWrongVendor = errors.New("device vendor is not NuPhy")
 
 // DeviceInfo represents NuPhy keyboard HID information
 type DeviceInfo struct {
-	Model    string
+	Model    device.Model
 	Firmware string
 	Path     string
 }
@@ -36,7 +37,7 @@ func GetDeviceInfo(d *hid.Device) (*DeviceInfo, error) {
 		return nil, err
 	}
 	return &DeviceInfo{
-		Model:    model,
+		Model:    device.Model(model),
 		Path:     info.Path,
 		Firmware: FormatVersion(info.ReleaseNbr),
 	}, nil