def serial(package, port, flow_control, packet_receipt_notification,
baud_rate):
"""Perform a Device Firmware Update on a device with a bootloader that supports serial DFU."""
#raise NotImplementedException('Serial transport currently is not supported')
"""Perform a Device Firmware Update on a device with a bootloader that supports BLE DFU."""
if port is None:
click.echo("Please specify serial port.")
return
if flow_control is None:
flow_control = DfuTransportSerial.DEFAULT_FLOW_CONTROL
if packet_receipt_notification is None:
packet_receipt_notification = DfuTransportSerial.DEFAULT_PRN
if baud_rate is None:
baud_rate = DfuTransportSerial.DEFAULT_BAUD_RATE
logger.info("Using board at serial port: {}".format(port))
serial_backend = DfuTransportSerial(com_port=str(port),
baud_rate=baud_rate,
flow_control=flow_control,
prn=packet_receipt_notification)
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT,
update_progress)
dfu = Dfu(zip_file_path=package, dfu_transport=serial_backend)
if logger.getEffectiveLevel() > logging.INFO:
with click.progressbar(length=dfu.dfu_get_total_size()) as bar:
global global_bar
global_bar = bar
dfu.dfu_send_images()
else:
dfu.dfu_send_images()
click.echo("Device programmed.")
def do_serial(package, port, connect_delay, flow_control, packet_receipt_notification, baud_rate, ping):
if flow_control is None:
flow_control = DfuTransportSerial.DEFAULT_FLOW_CONTROL
if packet_receipt_notification is None:
packet_receipt_notification = DfuTransportSerial.DEFAULT_PRN
if baud_rate is None:
baud_rate = DfuTransportSerial.DEFAULT_BAUD_RATE
if ping is None:
ping = False
logger.info("Using board at serial port: {}".format(port))
serial_backend = DfuTransportSerial(com_port=str(port), baud_rate=baud_rate,
flow_control=flow_control, prn=packet_receipt_notification, do_ping=ping)
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT, update_progress)
dfu = Dfu(zip_file_path = package, dfu_transport = serial_backend, connect_delay = connect_delay)
if logger.getEffectiveLevel() > logging.INFO:
with click.progressbar(length=dfu.dfu_get_total_size()) as bar:
global global_bar
global_bar = bar
dfu.dfu_send_images()
else:
dfu.dfu_send_images()
click.echo("Device programmed.")
def serial(package, port, baudrate, flowcontrol, singlebank, touch):
"""Program a device with bootloader that support serial DFU"""
serial_backend = DfuTransportSerial(port, baudrate, flowcontrol, singlebank, touch)
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT, update_progress)
dfu = Dfu(package, dfu_transport=serial_backend)
click.echo("Upgrading target on {1} with DFU package {0}. Flow control is {2}, {3} bank, Touch {4}"
.format(package, port, "enabled" if flowcontrol else "disabled", "Single" if singlebank else "Dual", touch if touch > 0 else "disabled"))
try:
dfu.dfu_send_images()
except Exception as e:
click.echo("")
click.echo("Failed to upgrade target. Error is: {0}".format(e))
traceback.print_exc(file=sys.stdout)
click.echo("")
click.echo("Possible causes:")
click.echo("- Selected Bootloader version does not match the one on Bluefruit device.")
click.echo(" Please upgrade the Bootloader or select correct version in Tools->Bootloader.")
click.echo("- Baud rate must be 115200, Flow control must be off.")
click.echo("- Target is not in DFU mode. Ground DFU pin and RESET and release both to enter DFU mode.")
return False
click.echo("Device programmed.")
return True
def serial(package, port, baudrate, flowcontrol):
"""Program a device with bootloader that support serial DFU"""
serial_backend = DfuTransportSerial(port, baudrate, flowcontrol)
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT, update_progress)
dfu = Dfu(package, dfu_transport=serial_backend)
click.echo("Upgrading target on {1} with DFU package {0}. Flow control is {2}."
.format(package, port, "enabled" if flowcontrol else "disabled"))
try:
dfu.dfu_send_images()
except Exception as e:
click.echo("")
click.echo("Failed to upgrade target. Error is: {0}".format(e.message))
click.echo("")
click.echo("Possible causes:")
click.echo("- Bootloader, SoftDevice or Application on target "
"does not match the requirements in the DFU package.")
click.echo("- Baud rate must be 115200, Flow control must be off.")
click.echo("- Target is not in DFU mode. Ground DFU pin and RESET and release both to enter DFU mode.")
return False
click.echo("Device programmed.")
return True
def serial(package, port, baudrate, flowcontrol):
"""Program a device with bootloader that support serial DFU"""
serial_backend = DfuTransportSerial(port, baudrate, flowcontrol)
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT, update_progress)
dfu = Dfu(package, dfu_transport=serial_backend)
click.echo("Upgrading target on {1} with DFU package {0}. Flow control is {2}."
.format(package, port, "enabled" if flowcontrol else "disabled"))
try:
with click.progressbar(length=100) as bar:
global global_bar
global_bar = bar
dfu.dfu_send_images()
except Exception as e:
click.echo("")
click.echo("Failed to upgrade target. Error is: {0}".format(e.message))
click.echo("")
click.echo("Possible causes:")
click.echo("- bootloader, SoftDevice or application on target "
"does not match the requirements in the DFU package.")
click.echo("- baud rate or flow control is not the same as in the target bootloader.")
click.echo("- target is not in DFU mode. If using the SDK examples, "
"press Button 4 and RESET and release both to enter DFU mode.")
return False
click.echo("Device programmed.")
return True
def do_serial(package,
port,
connect_delay,
flow_control,
packet_receipt_notification,
baud_rate,
ping,
timeout,
dfuStart=None):
if flow_control is None:
flow_control = DfuTransportSerial.DEFAULT_FLOW_CONTROL
if packet_receipt_notification is None:
packet_receipt_notification = DfuTransportSerial.DEFAULT_PRN
if baud_rate is None:
baud_rate = DfuTransportSerial.DEFAULT_BAUD_RATE
if ping is None:
ping = False
if port is None:
raise Exception("Please specify port!")
if timeout is None:
timeout = DfuTransportSerial.DEFAULT_TIMEOUT
logger.info(
"Using board at serial port: {0}, flow_control: {1}, baud_rate: {2}, ping: {3}"
.format(port, flow_control, baud_rate, ping))
serial_backend = DfuTransportSerial(com_port=str(port),
baud_rate=baud_rate,
flow_control=flow_control,
prn=packet_receipt_notification,
do_ping=ping,
timeout=timeout)
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT,
update_progress)
if dfuStart:
logger.info('Enterring DFU mode ...')
send_text_message(str(port), baud_rate, dfuStart, flow_control)
logger.info('Done')
dfu = Dfu(zip_file_path=package,
dfu_transport=serial_backend,
connect_delay=connect_delay)
if logger.getEffectiveLevel() > logging.INFO:
with click.progressbar(length=dfu.dfu_get_total_size()) as bar:
global global_bar
global_bar = bar
dfu.dfu_send_images()
else:
dfu.dfu_send_images()
logger.info("Device programmed.")
def setUp(self):
setup_logging()
# Assert that environment variables are setUp before starting tests.
# TODO: create generic functionality for fetching environment variables that map
# TODO: communication ports to PCA versions
# TODO: setup target nRF5X device to a given state (bootloader+sd+application)
if self.DEVKEY_PORT not in os.environ:
self.fail(
"Environment variable {0} not found. "
"Must specify serial port with development kit connected.".
format(self.DEVKEY_PORT))
self.transport = DfuTransportSerial(os.environ[self.DEVKEY_PORT],
baud_rate=38400,
flow_control=True)
def serial(package, port):
"""Perform a Device Firmware Update on a device with a bootloader that supports serial DFU."""
#raise NotImplementedException('Serial transport currently is not supported')
"""Perform a Device Firmware Update on a device with a bootloader that supports BLE DFU."""
if port is None:
click.echo("Please specify serial port.")
return
logger.info("Using board at serial port: {}".format(port))
serial_backend = DfuTransportSerial(com_port=str(port))
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT, update_progress)
dfu = Dfu(zip_file_path = package, dfu_transport = serial_backend)
if logger.getEffectiveLevel() > logging.INFO:
with click.progressbar(length=dfu.dfu_get_total_size()) as bar:
global global_bar
global_bar = bar
dfu.dfu_send_images()
else:
dfu.dfu_send_images()
click.echo("Device programmed.")
def serial(package, port):
"""Perform a Device Firmware Update on a device with a bootloader that supports serial DFU."""
#raise NotImplementedException('Serial transport currently is not supported')
"""Perform a Device Firmware Update on a device with a bootloader that supports BLE DFU."""
if port is None:
click.echo("Please specify serial port.")
return
logger.info("Using board at serial port: {}".format(port))
serial_backend = DfuTransportSerial(com_port=str(port))
serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT, update_progress)
dfu = Dfu(zip_file_path = package, dfu_transport = serial_backend)
if logger.getEffectiveLevel() > logging.INFO:
with click.progressbar(length=dfu.dfu_get_total_size()) as bar:
global global_bar
global_bar = bar
dfu.dfu_send_images()
else:
dfu.dfu_send_images()
click.echo("Device programmed.")
def setUp(self):
setup_logging()
# Assert that environment variables are setUp before starting tests.
# TODO: create generic functionality for fetching environment variables that map
# TODO: communication ports to PCA versions
# TODO: setup target nRF5X device to a given state (bootloader+sd+application)
if self.DEVKEY_PORT not in os.environ:
self.fail("Environment variable {0} not found. "
"Must specify serial port with development kit connected."
.format(self.DEVKEY_PORT))
self.transport = DfuTransportSerial(os.environ[self.DEVKEY_PORT],
baud_rate=38400,
flow_control=True)
class TestDfuTransportSerial(unittest.TestCase):
DEVKEY_PORT = "NORDICSEMI_PCA10028_1_PORT"
def setUp(self):
setup_logging()
# Assert that environment variables are setUp before starting tests.
# TODO: create generic functionality for fetching environment variables that map
# TODO: communication ports to PCA versions
# TODO: setup target nRF5X device to a given state (bootloader+sd+application)
if self.DEVKEY_PORT not in os.environ:
self.fail(
"Environment variable {0} not found. "
"Must specify serial port with development kit connected.".
format(self.DEVKEY_PORT))
self.transport = DfuTransportSerial(os.environ[self.DEVKEY_PORT],
baud_rate=38400,
flow_control=True)
def tearDown(self):
if self.transport and self.transport.is_open():
self.transport.close()
def test_open_close(self):
self.transport.open()
self.assertTrue(self.transport.is_open())
self.transport.close()
self.assertFalse(self.transport.is_open())
def test_dfu_methods(self):
def timeout_callback(log_message):
logging.debug("timeout_callback. Message: %s", log_message)
def progress_callback(progress, log_message, done):
logging.debug("Log message: %s, Progress: %d, done: %s",
log_message, progress, done)
def error_callback(log_message=""):
logging.error("Log message: %s", log_message)
self.transport.register_events_callback(DfuEvent.TIMEOUT_EVENT,
timeout_callback)
self.transport.register_events_callback(DfuEvent.PROGRESS_EVENT,
progress_callback)
self.transport.register_events_callback(DfuEvent.ERROR_EVENT,
error_callback())
firmware = ''
test_firmware_path = os.path.join("firmwares",
"pca10028_nrf51422_xxac_blinky.bin")
with open(test_firmware_path, 'rb') as f:
while True:
data = f.read()
if data:
firmware += data
else:
break
crc = crc16.calc_crc16(firmware, 0xffff)
self.transport.open()
# Sending start DFU command to target
self.transport.send_start_dfu(HexType.APPLICATION,
app_size=len(firmware),
softdevice_size=0,
bootloader_size=0)
# Sending DFU init packet to target
init_packet_vars = {
PacketField.DEVICE_TYPE: 1,
PacketField.DEVICE_REVISION: 2,
PacketField.APP_VERSION: 0xfffa,
PacketField.REQUIRED_SOFTDEVICES_ARRAY: [0x005a],
PacketField.NORDIC_PROPRIETARY_OPT_DATA_FIRMWARE_CRC16: crc
}
pkt = Packet(init_packet_vars)
self.transport.send_init_packet(pkt.generate_packet())
# Sending firmware to target
self.transport.send_firmware(firmware)
# Validating firmware
self.transport.send_validate_firmware()
self.transport.send_activate_firmware()
self.transport.close()
from nordicsemi.dfu.dfu import Dfu
from nordicsemi.dfu.dfu_transport_serial import DfuTransportSerial
transport = DfuTransportSerial("/dev/tty/usbmodem14201", 115200, True, True, False)
a = Dfu("", dfu_transport=transport)
print(a)
class TestDfuTransportSerial(unittest.TestCase):
DEVKEY_PORT = "NORDICSEMI_PCA10028_1_PORT"
def setUp(self):
setup_logging()
# Assert that environment variables are setUp before starting tests.
# TODO: create generic functionality for fetching environment variables that map
# TODO: communication ports to PCA versions
# TODO: setup target nRF5X device to a given state (bootloader+sd+application)
if self.DEVKEY_PORT not in os.environ:
self.fail("Environment variable {0} not found. "
"Must specify serial port with development kit connected."
.format(self.DEVKEY_PORT))
self.transport = DfuTransportSerial(os.environ[self.DEVKEY_PORT],
baud_rate=38400,
flow_control=True)
def tearDown(self):
if self.transport and self.transport.is_open():
self.transport.close()
def test_open_close(self):
self.transport.open()
self.assertTrue(self.transport.is_open())
self.transport.close()
self.assertFalse(self.transport.is_open())
def test_dfu_methods(self):
def timeout_callback(log_message):
logging.debug("timeout_callback. Message: %s", log_message)
def progress_callback(progress, log_message, done):
logging.debug("Log message: %s, Progress: %d, done: %s", log_message, progress, done)
def error_callback(log_message=""):
logging.error("Log message: %s", log_message)
self.transport.register_events_callback(DfuEvent.TIMEOUT_EVENT, timeout_callback)
self.transport.register_events_callback(DfuEvent.PROGRESS_EVENT, progress_callback)
self.transport.register_events_callback(DfuEvent.ERROR_EVENT, error_callback())
firmware = ''
test_firmware_path = os.path.join("firmwares", "pca10028_nrf51422_xxac_blinky.bin")
with open(test_firmware_path, 'rb') as f:
while True:
data = f.read()
if data:
firmware += data
else:
break
crc = crc16.calc_crc16(firmware, 0xffff)
self.transport.open()
# Sending start DFU command to target
self.transport.send_start_dfu(HexType.APPLICATION,
app_size=len(firmware),
softdevice_size=0,
bootloader_size=0)
# Sending DFU init packet to target
init_packet_vars = {
PacketField.DEVICE_TYPE: 1,
PacketField.DEVICE_REVISION: 2,
PacketField.APP_VERSION: 0xfffa,
PacketField.REQUIRED_SOFTDEVICES_ARRAY: [0x005a],
PacketField.NORDIC_PROPRIETARY_OPT_DATA_FIRMWARE_CRC16: crc
}
pkt = Packet(init_packet_vars)
self.transport.send_init_packet(pkt.generate_packet())
# Sending firmware to target
self.transport.send_firmware(firmware)
# Validating firmware
self.transport.send_validate_firmware()
self.transport.send_activate_firmware()
self.transport.close()
