Reorder files, add comments, init module

Author: johanstokking

.gitignore

@@ -22,3 +22,6 @@ _testmain.go
 *.exe
 *.test
 *.prof
+
+# Development environment
+.envrc

cayennelpp/decoder.go renamed to decoder.go

@@ -1,4 +1,4 @@
-// Copyright © 2017 The Things Network
+// Copyright © 2021 The Things Network
 // Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 
 package cayennelpp
@@ -9,8 +9,10 @@ import (
 	"io"
 )
 
-var ErrInvalidChannel = errors.New("cayennelpp: unknown type")
+// ErrInvalidChannelType indicates that the channel type is invalid.
+var ErrInvalidChannelType = errors.New("cayennelpp: unknown type")
 
+// UplinkTarget represents a target that processes decoded uplink values.
 type UplinkTarget interface {
 	DigitalInput(channel, value uint8)
 	DigitalOutput(channel, value uint8)
@@ -26,10 +28,12 @@ type UplinkTarget interface {
 	GPS(channel uint8, latitude, longitude, altitude float32)
 }
 
+// DownlinkTarget represents a target that processes decoded downlink values.
 type DownlinkTarget interface {
 	Port(channel uint8, value float32)
 }
 
+// Decoder decodes CayenneLPP encoded values.
 type Decoder interface {
 	DecodeUplink(target UplinkTarget) error
 	DecodeDownlink(target DownlinkTarget) error
@@ -39,6 +43,7 @@ type decoder struct {
 	r io.Reader
 }
 
+// NewDecoder instantiates a CayenneLPP decoder.
 func NewDecoder(r io.Reader) Decoder {
 	return &decoder{r}
 }
@@ -79,7 +84,7 @@ func (d *decoder) DecodeUplink(target UplinkTarget) error {
 		case GPS:
 			err = d.decodeGPS(buf[0], target)
 		default:
-			err = ErrInvalidChannel
+			err = ErrInvalidChannelType
 		}
 		if err != nil {
 			return err

cayennelpp/decoder_test.go renamed to decoder_test.go

@@ -1,4 +1,4 @@
-// Copyright © 2017 The Things Network
+// Copyright © 2021 The Things Network
 // Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 
 package cayennelpp
@@ -131,7 +131,7 @@ func TestDecode(t *testing.T) {
 		target := &target{make(map[uint8]interface{})}
 
 		err := decoder.DecodeUplink(target)
-		a.So(err, ShouldEqual, ErrInvalidChannel)
+		a.So(err, ShouldEqual, ErrInvalidChannelType)
 	}
 
 	// Not enough data: uplink

cayennelpp/encoder.go renamed to encoder.go

@@ -1,4 +1,4 @@
-// Copyright © 2017 The Things Network
+// Copyright © 2021 The Things Network
 // Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 
 package cayennelpp
@@ -9,6 +9,7 @@ import (
 	"io"
 )
 
+// Encoder encodes values to CayenneLPP.
 type Encoder interface {
 	Grow(n int)
 	Bytes() []byte
@@ -33,6 +34,7 @@ type encoder struct {
 	buf *bytes.Buffer
 }
 
+// NewEncoder instantiates an CayenneLPP encoder.
 func NewEncoder() Encoder {
 	return &encoder{
 		buf: new(bytes.Buffer),

cayennelpp/encoder_test.go renamed to encoder_test.go

@@ -1,4 +1,4 @@
-// Copyright © 2017 The Things Network
+// Copyright © 2021 The Things Network
 // Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 
 package cayennelpp

go.mod

@@ -0,0 +1,5 @@
+module github.com/TheThingsNetwork/go-cayenne-lib
+
+go 1.15
+
+require github.com/smartystreets/assertions v1.2.0

go.sum

@@ -0,0 +1,2 @@
+github.com/smartystreets/assertions v1.2.0 h1:42S6lae5dvLc7BrLu/0ugRtcFVjoJNMC/N3yZFZkDFs=
+github.com/smartystreets/assertions v1.2.0/go.mod h1:tcbTF8ujkAEcZ8TElKY+i30BzYlVhC/LOxJk7iOWnoo=

cayennelpp/types.go renamed to types.go

@@ -1,4 +1,4 @@
-// Copyright © 2017 The Things Network
+// Copyright © 2021 The Things Network
 // Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 
 package cayennelpp