add LICENSE and README

types.go -> eventTypes.go
reorganize example folder structure

LICENSE.md

@@ -0,0 +1,193 @@
+# Apache License
+
+_Version 2.0, January 2004_
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+- **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+  this License; and
+- **(b)** You must cause any modified files to carry prominent notices stating that You
+  changed the files; and
+- **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+  all copyright, patent, trademark, and attribution notices from the Source form
+  of the Work, excluding those notices that do not pertain to any part of the
+  Derivative Works; and
+- **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+  Derivative Works that You distribute must include a readable copy of the
+  attribution notices contained within such NOTICE file, excluding those notices
+  that do not pertain to any part of the Derivative Works, in at least one of the
+  following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along
+  with the Derivative Works; or, within a display generated by the Derivative
+  Works, if and wherever such third-party notices normally appear. The contents of
+  the NOTICE file are for informational purposes only and do not modify the
+  License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work,
+  provided that such additional attribution notices cannot be construed as
+  modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets `[]` replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same “printed page” as the copyright notice for easier identification within
+third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

README.md

@@ -0,0 +1,39 @@
+# Gome-Assistant
+
+Golang ↔️ Home Assistant
+
+Write your [Home Assistant](https://www.home-assistant.io/) automations with a strongly-typed Golang library!
+
+## Why?
+
+My Home Assistant automation journey started with [Node-RED](https://nodered.org/). Since I already know how to write javascript, I started stuffing all my logic into code nodes in Node-RED.
+
+Then one day I stumbled on [Appdaemon](https://appdaemon.readthedocs.io/en/latest/), which lets you write automations entirely in Python. I switched all my automations over because of the flexibility I gained from writing my automations in code.
+
+While autocomplete in your IDE seems trivial, it's an important feature many developers take for granted. Python isn't great at it.
+
+I wanted to learn Golang, and had the idea to wrap the Home Assistant websocket API with a Go library. Go's strong typing means I don't have to remember the API because my IDE will fill in the blanks for me. So anyway, here's my first Go project, I hope you find it useful 😁
+
+## Quick Start
+
+### Installation
+
+```
+go get github.com/saml-dev/gome-assistant
+```
+
+### Write your automations
+
+Check out `example/example.go` for an example of the 3 types of automations — schedules, entity listeners, and event listeners. Instead of copying and pasting, try typing it our yourself to see how autocomplete guides you through the setup using a builder pattern. You can also check out some of the other options you see in the autocomplete.
+
+### Run your code
+
+Keeping with the simplicity that Go is famous for, you don't need a whole environment or docker container to run Gome-Assistant. It's just a binary like any other Go code you would write. So once you have your automations, you can run it however you like — using `screen` or `tmux`, a cron job, or wrap it up in a docker container if you just can't get enough docker!
+
+_Note: I may provide a Docker image in the future with file watching to restart gome-assistant, to make it easier to use gome-assistant on a fully managed Home Assistant installation._
+
+## Disclaimer
+
+Gome-Assistant is a new library, and I'm opening it up early to get some user feedback on the API and help shape the direction. I plan for it to grow to cover all Home Assistant use cases, services, and event types. So it's possible — maybe likely — that breaking changes will happen before v1.0.0!
+
+## API Reference (WIP)

eventListener.go

@@ -40,7 +40,7 @@ type eventListenerBuilder1 struct {
 	eventListener
 }
 
-func (b eventListenerBuilder1) EventType(ets ...string) eventListenerBuilder2 {
+func (b eventListenerBuilder1) EventTypes(ets ...string) eventListenerBuilder2 {
 	b.eventTypes = ets
 	return eventListenerBuilder2(b)
 }

example/example.go

@@ -0,0 +1,74 @@
+package main
+
+import (
+	"encoding/json"
+	"log"
+	"time"
+
+	ga "github.com/saml-dev/gome-assistant"
+)
+
+func main() {
+	app := ga.NewApp("0.0.0.0:8123") // Replace with your Home Assistant IP Address
+	defer app.Cleanup()
+
+	pantryDoor := ga.
+		EntityListenerBuilder().
+		EntityIds("binary_sensor.pantry_door").
+		Call(pantryLights).
+		Build()
+
+	_11pmSched := ga.
+		ScheduleBuilder().
+		Call(lightsOut).
+		Daily().
+		At("23:00").
+		Build()
+
+	zwaveEventListener := ga.
+		EventListenerBuilder().
+		EventTypes("zwave_js_value_notification").
+		Call(onEvent).
+		Build()
+
+	app.RegisterEntityListener(pantryDoor)
+	app.RegisterSchedule(_11pmSched)
+	app.RegisterEventListener(zwaveEventListener)
+
+	app.Start()
+
+}
+
+func pantryLights(service *ga.Service, sensor ga.EntityData) {
+	l := "light.pantry"
+	if sensor.ToState == "on" {
+		service.HomeAssistant.TurnOn(l)
+	} else {
+		service.HomeAssistant.TurnOff(l)
+	}
+}
+
+func onEvent(service *ga.Service, data ga.EventData) {
+	// Since the structure of the event changes depending
+	// on the event type, you can Unmarshal the raw json
+	// into a Go type. If a type for your event doesn't
+	// exist, you can write it yourself! PR's welcome to
+	// the eventTypes.go file :)
+	ev := ga.EventZWaveJSValueNotification{}
+	json.Unmarshal(data.RawEventJSON, &ev)
+	log.Default().Println(ev)
+}
+
+func lightsOut(service *ga.Service, state *ga.State) {
+	service.Light.TurnOff("light.outside_lights")
+	s, err := state.Get("binary_sensor.living_room_motion")
+	if err != nil {
+		log.Default().Println("couldnt get living room motion state, doing nothing")
+		return
+	}
+
+	// if no motion detected in living room for 30mins
+	if s.State == "off" && time.Now().Sub(s.LastChanged).Minutes() > 30 {
+		service.Light.TurnOff("light.main_lights")
+	}
+}

example/main/testing.go

@@ -1,61 +0,0 @@
-package main
-
-import (
-	"encoding/json"
-	"log"
-
-	ga "github.com/saml-dev/gome-assistant"
-)
-
-func main() {
-	app := ga.NewApp("192.168.86.67:8123")
-	defer app.Cleanup()
-	pantryDoor := ga.
-		EntityListenerBuilder().
-		EntityIds("binary_sensor.pantry_door").
-		Call(pantryLights).
-		Build()
-	zwaveEventListener := ga.
-		EventListenerBuilder().
-		EventType("zwave_js_value_notification").
-		Call(onEvent).
-		Build()
-	app.RegisterEntityListener(pantryDoor)
-	app.RegisterSchedule(ga.ScheduleBuilder().Call(cool).Every("5s").Build())
-	app.RegisterEventListener(zwaveEventListener)
-
-	app.Start()
-
-}
-
-func pantryLights(service *ga.Service, data ga.EntityData) {
-	l := "group.kitchen_ceiling_lights"
-	// service.HomeAssistant.Toggle("group.living_room_lamps", map[string]any{"brightness_pct": 100})
-	// service.Light.Toggle("light.entryway_lamp", map[string]any{"brightness_pct": 100})
-	if data.ToState == "on" {
-		service.HomeAssistant.TurnOn(l)
-	} else {
-		service.HomeAssistant.TurnOff(l)
-	}
-}
-
-func onEvent(service *ga.Service, data ga.EventData) {
-	// service.HomeAssistant.Toggle("light.el_gato_key_lights")
-	ev := ga.EventZWaveJSValueNotification{}
-	json.Unmarshal(data.RawEventJSON, &ev)
-	log.Default().Println(ev)
-}
-
-func cool(service *ga.Service, state *ga.State) {
-	// service.InputDatetime.Set("input_datetime.garage_last_triggered_ts", time.Now())
-	// service.Light.TurnOn("light.entryway_lamp")
-	// log.Default().Println("B")
-}
-
-func c(service *ga.Service, state *ga.State) {
-	// log.Default().Println("C")
-}
-
-func listenerCB(service *ga.Service, data ga.EntityData) {
-	log.Default().Println("hi")
-}