ambrose
/
leet
mirror of https://github.com/serverwentdown/leet.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Comment on APIs

pull/1/head
Ambrose Chua 2019-04-12 16:08:54 +08:00
parent f3403d6196
commit 356df1be20
3 changed files with 63 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -5,7 +5,7 @@ Environmental lighting over gRPC (WTF?!)
## WTF?!
At home, I have a strip of 287 WS2812Bs connected to a Raspberry Pi, that needs to be used as a light, mood lighting, and for notifications. I don't want to be a typical person and write a monolithic application, so `leet` is a simple gRPC server that renders basic opacity composition and buffered animations onto the LED strip. This also enables me to add aditional sources of data in the future from anywhere on my home network, including servers, phones and your IoT Blockchain AI appliances.
At home, I have a strip of 287 WS2812B LEDs connected to a Raspberry Pi, that needs to be used as a light, mood lighting, and for notifications. I don't want to be a typical person and write a monolithic application, so `leet` is a simple gRPC server that renders basic opacity composition and buffered animations onto the LED strip. This also enables me to add aditional sources of data in the future from anywhere on my home network, including servers, phones and your IoT Blockchain AI appliances.
## Architecture
@ -23,8 +23,14 @@ At home, I have a strip of 287 WS2812Bs connected to a Raspberry Pi, that needs
---------------------------------- -----------------
```
## Protocol
See [`framebuffer.proto`](framebuffer/framebuffer.proto) for the actual gRPC protocol
## Developing
1. [Install](https://grpc.io/docs/quickstart/go.html#install-protocol-buffers-v3) `protoc` and `protoc-gen-go`
2. Install the `rpi_ws281x` library: `./get-ws2812x.sh` (WARNING: this installs four files into /usr/local)
3. Get dependencies: `go get`
4. Start building with `go build`

26
framebuffer/framebuffer.pb.go
View File

@ -22,6 +22,13 @@ var _ = math.Inf
// proto package needs to be updated.
const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package
//
//Layer defines some default layers for compositing animations onto for
//various purposes, and also defines some generic layers. Each service
//should be allocated a unique enum eventually.
//
//In the future, this system should be replaced by a configuration file
//that assigns priorities to each service.
type Layer int32
const (
@ -85,6 +92,10 @@ func (Layer) EnumDescriptor() ([]byte, []int) {
return fileDescriptor_4476fbda566a3634, []int{0}
}
//
//FrameData represents either an array of dots or a fixed fill color to apply
//to all dots. Having two use cases makes it easier for applications to
//draw solid fill colors.
type FrameData struct {
// ARGB
Dots []uint32 `protobuf:"fixed32,1,rep,packed,name=dots,proto3" json:"dots,omitempty"`
@ -133,6 +144,10 @@ func (m *FrameData) GetFill() uint32 {
return 0
}
//
//FrameBuffer represents an entire frame together with a layer tag. It also
//defines a timestamp that can be used within a FrameSequence to define the
//duration a frame will be shown.
type FrameBuffer struct {
Frame *FrameData `protobuf:"bytes,1,opt,name=frame,proto3" json:"frame,omitempty"`
Timestamp uint32 `protobuf:"fixed32,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
@ -188,6 +203,13 @@ func (m *FrameBuffer) GetLayer() Layer {
return Layer_NONE
}
//
//FrameSequence buffers a series of frames to be drawn one by one at intervals
//defined by the timestamp included in the FrameBuffers. Useful for running
//smooth animations.
//
//In the future, this should have more metadata like looping counts and async
//animations.
type FrameSequence struct {
Frames []*FrameBuffer `protobuf:"bytes,1,rep,name=frames,proto3" json:"frames,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
@ -306,7 +328,9 @@ const _ = grpc.SupportPackageIsVersion4
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type DrawerClient interface {
// DrawFrame draws one frame
DrawFrame(ctx context.Context, in *FrameBuffer, opts ...grpc.CallOption) (*DrawResponse, error)
// DrawFrames draws a series of frames
DrawFrames(ctx context.Context, in *FrameSequence, opts ...grpc.CallOption) (*DrawResponse, error)
}
@ -338,7 +362,9 @@ func (c *drawerClient) DrawFrames(ctx context.Context, in *FrameSequence, opts .
// DrawerServer is the server API for Drawer service.
type DrawerServer interface {
// DrawFrame draws one frame
DrawFrame(context.Context, *FrameBuffer) (*DrawResponse, error)
// DrawFrames draws a series of frames
DrawFrames(context.Context, *FrameSequence) (*DrawResponse, error)
}

30
framebuffer/framebuffer.proto
View File

@ -1,5 +1,13 @@
syntax = "proto3";
/*
Layer defines some default layers for compositing animations onto for
various purposes, and also defines some generic layers. Each service
should be allocated a unique enum eventually.
In the future, this system should be replaced by a configuration file
that assigns priorities to each service.
*/
enum Layer {
NONE = 0;
// Well-known layers
@ -19,18 +27,36 @@ enum Layer {
GENERAL_9 = 49;
}
/*
FrameData represents either an array of dots or a fixed fill color to apply
to all dots. Having two use cases makes it easier for applications to
draw solid fill colors.
*/
message FrameData {
// ARGB
repeated fixed32 dots = 1;
fixed32 fill = 2;
}
/*
FrameBuffer represents an entire frame together with a layer tag. It also
defines a timestamp that can be used within a FrameSequence to define the
duration a frame will be shown.
*/
message FrameBuffer {
FrameData frame = 1;
fixed32 timestamp = 3;
Layer layer = 4;
}
/*
FrameSequence buffers a series of frames to be drawn one by one at intervals
defined by the timestamp included in the FrameBuffers. Useful for running
smooth animations.
In the future, this should have more metadata like looping counts and async
animations.
*/
message FrameSequence {
repeated FrameBuffer frames = 1;
}
@ -39,7 +65,9 @@ message DrawResponse {
}
service Drawer {
// DrawFrame draws one frame
rpc DrawFrame (FrameBuffer) returns (DrawResponse) {}
// DrawFrames draws a series of frames
rpc DrawFrames (FrameSequence) returns (DrawResponse) {}
}