{{ message }}
Repository navigation
Expand file tree
/
Copy pathbinary_configurator.py
More file actions
291 lines (260 loc) · 12.6 KB
/
Copy pathbinary_configurator.py
File metadata and controls
291 lines (260 loc) · 12.6 KB
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
#!/usr/bin/python
from enum import Enum
import shutil
import sys
import os
import argparse
import hashlib
import json
from json import JSONEncoder
from random import randint
from os.path import dirname
import gzip
import UnifiedConfiguration
import serials_find
import upload_via_esp8266_backpack
sys.path.append(dirname(__file__) + '/external/esptool')
from external.esptool import esptool
class ElrsUploadResult:
# SUCCESS
Success = 0
# ERROR: Unspecified
ErrorGeneral = -1
# ERROR: target mismatch
ErrorMismatch = -2
class DeviceType(Enum):
VRX = 'vrx'
TXBP = 'txbp'
TIMER = 'timer'
def __str__(self):
return self.value
class MCUType(Enum):
ESP8266 = 'esp8266'
ESP32 = 'esp32'
def __str__(self):
return self.value
class UploadMethod(Enum):
uart = 'uart'
passthru = 'passthru'
edgetx = 'etx'
wifi = 'wifi'
dir = 'dir'
def __str__(self):
return self.value
def upload_wifi(args, mcuType, upload_addr):
if args.port:
upload_addr = [args.port]
try:
if mcuType == MCUType.ESP8266:
with open(args.file.name, 'rb') as f_in:
with gzip.open('firmware.bin.gz', 'wb') as f_out:
shutil.copyfileobj(f_in, f_out)
upload_via_esp8266_backpack.do_upload('firmware.bin.gz', upload_addr, {})
else:
upload_via_esp8266_backpack.do_upload(args.file.name, upload_addr, {})
except Exception as e:
print("WIFI upload failed: %s" % e, file=sys.stderr)
return ElrsUploadResult.ErrorGeneral
return ElrsUploadResult.Success
def upload_esp8266_uart(args):
if args.port == None:
args.port = serials_find.get_serial_port()
try:
esptool.main(['--chip', 'esp8266', '--port', args.port, '--baud', str(args.baud), '--after', 'soft_reset', 'write_flash', '0x0000', args.file.name])
except:
return ElrsUploadResult.ErrorGeneral
return ElrsUploadResult.Success
def upload_esp8266_etx(args):
if args.port == None:
args.port = serials_find.get_serial_port()
try:
esptool.main(['--passthrough', '--chip', 'esp8266', '--port', args.port, '--baud', '460800', '--before', 'etx', '--after', 'hard_reset', 'write_flash', '0x0000', args.file.name])
except:
return ElrsUploadResult.ErrorGeneral
return ElrsUploadResult.Success
def upload_esp8266_passthru(args):
if args.port == None:
args.port = serials_find.get_serial_port()
try:
esptool.main(['--passthrough', '--chip', 'esp8266', '--port', args.port, '--baud', '230400', '--before', 'passthru', '--after', 'hard_reset', 'write_flash', '0x0000', args.file.name])
except:
return ElrsUploadResult.ErrorGeneral
return ElrsUploadResult.Success
def upload_esp32_uart(args):
if args.port == None:
args.port = serials_find.get_serial_port()
try:
dir = os.path.dirname(args.file.name)
start_addr = '0x0000' if args.platform.startswith('esp32-') else '0x1000'
esptool.main(['--chip', args.platform.replace('-', ''), '--port', args.port, '--baud', str(args.baud), '--after', 'hard_reset', 'write_flash', '-z', '--flash_mode', 'dio', '--flash_freq', '40m', '--flash_size', 'detect', start_addr, os.path.join(dir, 'bootloader.bin'), '0x8000', os.path.join(dir, 'partitions.bin'), '0xe000', os.path.join(dir, 'boot_app0.bin'), '0x10000', args.file.name])
except:
return ElrsUploadResult.ErrorGeneral
return ElrsUploadResult.Success
def upload_esp32_etx(args):
if args.port == None:
args.port = serials_find.get_serial_port()
try:
dir = os.path.dirname(args.file.name)
start_addr = '0x0000' if args.platform.startswith('esp32-') else '0x1000'
esptool.main(['--passthrough', '--chip', args.platform.replace('-', ''), '--port', args.port, '--baud', '460800', '--before', 'etx', '--after', 'hard_reset', 'write_flash', '-z', '--flash_mode', 'dio', '--flash_freq', '40m', '--flash_size', 'detect', start_addr, os.path.join(dir, 'bootloader.bin'), '0x8000', os.path.join(dir, 'partitions.bin'), '0xe000', os.path.join(dir, 'boot_app0.bin'), '0x10000', args.file.name])
except:
return ElrsUploadResult.ErrorGeneral
return ElrsUploadResult.Success
def upload_esp32_passthru(args):
if args.port == None:
args.port = serials_find.get_serial_port()
try:
dir = os.path.dirname(args.file.name)
start_addr = '0x0000' if args.platform.startswith('esp32-') else '0x1000'
esptool.main(['--passthrough', '--chip', args.platform.replace('-', ''), '--port', args.port, '--baud', '230400', '--before', 'passthru', '--after', 'hard_reset', 'write_flash', '-z', '--flash_mode', 'dio', '--flash_freq', '40m', '--flash_size', 'detect', start_addr, os.path.join(dir, 'bootloader.bin'), '0x8000', os.path.join(dir, 'partitions.bin'), '0xe000', os.path.join(dir, 'boot_app0.bin'), '0x10000', args.file.name])
except:
return ElrsUploadResult.ErrorGeneral
return ElrsUploadResult.Success
def upload_dir(mcuType, args):
if mcuType == MCUType.ESP8266:
with open(args.file.name, 'rb') as f_in:
with gzip.open(os.path.join(args.out, 'firmware.bin.gz'), 'wb') as f_out:
shutil.copyfileobj(f_in, f_out)
elif mcuType == MCUType.ESP32:
dir = os.path.dirname(args.file.name)
shutil.copy2(args.file.name, args.out)
shutil.copy2(os.path.join(dir, 'bootloader.bin'), args.out)
shutil.copy2(os.path.join(dir, 'partitions.bin'), args.out)
shutil.copy2(os.path.join(dir, 'boot_app0.bin'), args.out)
return ElrsUploadResult.Success
def upload(deviceType: DeviceType, mcuType: MCUType, args):
if args.baud == 0:
args.baud = 460800
if args.flash == UploadMethod.dir:
return upload_dir(mcuType, args)
elif deviceType == DeviceType.VRX:
if mcuType == MCUType.ESP8266:
if args.flash == UploadMethod.uart:
return upload_esp8266_uart(args)
elif args.flash == UploadMethod.wifi:
return upload_wifi(args, mcuType, ['elrs_vrx', 'elrs_vrx.local'])
elif mcuType == MCUType.ESP32:
if args.flash == UploadMethod.uart:
return upload_esp32_uart(args)
elif args.flash == UploadMethod.wifi:
return upload_wifi(args, mcuType, ['elrs_vrx', 'elrs_vrx.local'])
elif deviceType == DeviceType.TIMER:
if mcuType == MCUType.ESP8266:
if args.flash == UploadMethod.uart:
return upload_esp8266_uart(args)
elif args.flash == UploadMethod.wifi:
return upload_wifi(args, mcuType, ['elrs_timer', 'elrs_timer.local'])
elif mcuType == MCUType.ESP32:
if args.flash == UploadMethod.uart:
return upload_esp32_uart(args)
elif args.flash == UploadMethod.wifi:
return upload_wifi(args, mcuType, ['elrs_timer', 'elrs_timer.local'])
else:
if mcuType == MCUType.ESP8266:
if args.flash == UploadMethod.edgetx:
return upload_esp8266_etx(args)
elif args.flash == UploadMethod.uart:
return upload_esp8266_uart(args)
elif args.flash == UploadMethod.passthru:
return upload_esp8266_passthru(args)
elif args.flash == UploadMethod.wifi:
return upload_wifi(args, mcuType, ['elrs_txbp', 'elrs_txbp.local'])
if mcuType == MCUType.ESP32:
if args.flash == UploadMethod.edgetx:
return upload_esp32_etx(args)
elif args.flash == UploadMethod.uart:
return upload_esp32_uart(args)
elif args.flash == UploadMethod.passthru:
return upload_esp32_passthru(args)
elif args.flash == UploadMethod.wifi:
return upload_wifi(args, mcuType, ['elrs_txbp', 'elrs_txbp.local'])
print("Invalid upload method for firmware")
return ElrsUploadResult.ErrorGeneral
def length_check(l, f):
def x(s):
if (len(s) > l):
raise argparse.ArgumentTypeError(f'too long, {l} chars max')
else:
return s
return x
class readable_dir(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
prospective_dir=values
if not os.path.isdir(prospective_dir):
raise argparse.ArgumentTypeError("readable_dir:{0} is not a valid path".format(prospective_dir))
if os.access(prospective_dir, os.R_OK):
setattr(namespace,self.dest,prospective_dir)
else:
raise argparse.ArgumentTypeError("readable_dir:{0} is not a readable dir".format(prospective_dir))
class writeable_dir(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
prospective_dir=values
if not os.path.isdir(prospective_dir):
raise argparse.ArgumentTypeError("readable_dir:{0} is not a valid path".format(prospective_dir))
if os.access(prospective_dir, os.W_OK):
setattr(namespace,self.dest,prospective_dir)
else:
raise argparse.ArgumentTypeError("readable_dir:{0} is not a writeable dir".format(prospective_dir))
def main():
parser = argparse.ArgumentParser(description="Flash Binary Firmware")
# firmware/targets directory
parser.add_argument('--dir', action=readable_dir, default=None)
# Bind phrase
parser.add_argument('--phrase', type=str, help='Your personal binding phrase')
# WiFi Params
parser.add_argument('--ssid', type=length_check(32, "ssid"), required=False, help='Home network SSID')
parser.add_argument('--password', type=length_check(64, "password"), required=False, help='Home network password')
parser.add_argument('--auto-wifi', type=int, help='Interval (in seconds) before WiFi auto starts, if no connection is made')
parser.add_argument('--no-auto-wifi', action='store_true', help='Disables WiFi auto start if no connection is made')
# Unified target
parser.add_argument('--target', type=str, help='Unified target JSON path')
# Flashing options
parser.add_argument("--flash", type=UploadMethod, choices=list(UploadMethod), help="Flashing Method")
parser.add_argument('--out', action=writeable_dir, default=None)
parser.add_argument("--port", type=str, help="SerialPort or WiFi address to flash firmware to")
parser.add_argument("--baud", type=int, default=0, help="Baud rate for serial communication")
parser.add_argument("--force", action='store_true', default=False, help="Force upload even if target does not match")
parser.add_argument("--confirm", action='store_true', default=False, help="Confirm upload if a mismatched target was previously uploaded")
# Firmware file to patch/configure
parser.add_argument("file", nargs="?", type=argparse.FileType("r+b"))
args = parser.parse_args()
if args.dir != None:
os.chdir(args.dir)
vendor = args.target.split('.')[0]
hardware = args.target.split('.')[1]
target = args.target.split('.')[2]
with open('hardware/targets.json') as f:
targets = json.load(f)
args.platform = targets[vendor][hardware][target]['platform']
mcu = MCUType.ESP8266 if args.platform == "esp8285" else MCUType.ESP32
if args.file is None:
srcdir = targets[vendor][hardware][target]['firmware']
shutil.copy2(srcdir + '/firmware.bin', '.')
if os.path.exists(srcdir + '/bootloader.bin'): shutil.copy2(srcdir + '/bootloader.bin', '.')
if os.path.exists(srcdir + '/partitions.bin'): shutil.copy2(srcdir + '/partitions.bin', '.')
if os.path.exists(srcdir + '/boot_app0.bin'): shutil.copy2(srcdir + '/boot_app0.bin', '.')
args.file = open('firmware.bin', 'r+b')
json_flags = {}
if args.phrase is not None:
json_flags['uid'] = bindingPhraseHash = [x for x in hashlib.md5(("-DMY_BINDING_PHRASE=\""+args.phrase+"\"").encode()).digest()[0:6]]
if args.ssid is not None:
json_flags['wifi-ssid'] = args.ssid
if args.password is not None and args.ssid is not None:
json_flags['wifi-password'] = args.password
json_flags['flash-discriminator'] = randint(1,2**32-1)
json_flags['product-name'] = targets[vendor][hardware][target]['product_name']
UnifiedConfiguration.appendToFirmware(args.file, JSONEncoder().encode(json_flags))
if hardware == 'txbp':
devicetype = DeviceType.TXBP
elif hardware == 'timer':
devicetype = DeviceType.TIMER
else:
devicetype = DeviceType.VRX
ret = upload(devicetype, mcu, args)
sys.exit(ret)
if __name__ == '__main__':
try:
main()
except AssertionError as e:
print(e)
exit(1)
You can’t perform that action at this time.