summaryrefslogtreecommitdiff
path: root/wakeup.lua
blob: 8b9a893bff8d04887481e7737fa443f6f0292063 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
local wakeup = require("+wakeup")


--- Builds and returns a Wake-on-LAN magic packet for [[mac]] address.
local
function magic_packet (mac)
	local data = ""
	for octet in mac:gmatch("%x%x") do
		data = data .. string.char(tonumber(octet, 16))
	end
	if #data ~= 6 then
		error(string.format("Invalid MAC\t%q", mac), 2)
	end
	return string.char(0xff):rep(6) .. data:rep(16)
end


--- Perform the most basic preparations right after device booted up.
function wakeup:boot ()
	gpio.write(4, gpio.HIGH)
	gpio.mode(4, gpio.OUTPUT)
	self.data = magic_packet(self.mac)
	self.step = self.connect
end


--- This is the current state action of the wake-up state machine. It is a callable that has [[(self, [timer]) -> nil]]
--- signature. Steps are called sequentially, usually by a tmr.timer.
wakeup.step = wakeup.boot


--- Marks a failure that is pointless to attempt to recover from, e.g., if provided configuration is incomplete.
function wakeup:hard_failure (timer)
	print("Aborting...")
	return timer:unregister()
end


--- Marks a failure that device may recover from by restarting itself.
function wakeup:soft_failure ()
	node.restart()
end


function wakeup:connect ()
	self.step = self.wait_for_ip
	wifi.eventmon.register(wifi.eventmon.STA_GOT_IP, function ()
		self.step = self.sync_time
	end)
	wifi.setmode(wifi.STATION, false)
	wifi.sta.connect()
end


function wakeup:wait_for_ip ()
	-- no-op  -- TODO: soft_failure if too long?
end


function wakeup:now ()
	local time = rtctime.epoch2cal(rtctime.get())
	time.year = nil
	time.sec = nil
	return time
end


function wakeup:sync_time ()
	self.step = self.wait_for_time
	sntp.sync(
		self.sntp,
		function ()
			self.step = self.check_time
		end,
		function (code, err)
			print("SNTP sync failed", code, err)
			self.step = self.soft_failure
		end)
end


function wakeup:wait_for_time ()
	-- no-op  -- TODO: soft_failure if too long?
end


local
function compare (time, pattern)
	for key, value in pairs(pattern) do
		if time[key] ~= value then
			return false
		end
	end
	return true
end


--- Creates a new counter that has :up() method that returns true until it gets called N [[times]]. Then it returns only
--- false.
local
function new_counter (times)
	return {
		count = 0,
		times = times,
		up = function (self)
			self.count = self.count + 1
			return self.count <= self.times
		end,
	}
end


--- Creates new state machine action that sends out Wake-on-LAN magic packets to configured host N [[times]].
local
function start_sendout (times)
	local self = new_counter(times)
	self.udp = net.createUDPSocket()
	return function (wakeup, timer)
		if self:up() then
			print("Waking up", wakeup.mac, wakeup.addr)
			self.udp:send(wakeup.port, wakeup.addr, wakeup.data)
		else
			self.udp:close()
			timer:unregister()
			wifi.setmode(wifi.NULLMODE, false)
			gpio.write(4, gpio.HIGH)
			print("Done")
		end
	end
end


function wakeup:check_time (timer)
	if compare(self:now(), self.when) then
		gpio.write(4, gpio.LOW)
		self.step = start_sendout(5)
	else
		print("Not yet time")
		timer:unregister()
	end
end


return wakeup