SQNSUpgrade Documentation is unclear

[pirate]

There are a number of issues with the SQNSUpgrade procedure documentation here: https://github.com/pycom/pycom-documentation/blob/master/tutorials/lte/firmware.md

1. No explanation given for how to get sqnsupgrade code onto board, adding it as a lib in a project leads to no property run on sqnsupgrade.
   Solution: explain that sqnsupgrade folder in lib needs to be uploaded as a standalone project, not a lib

2. No explanation given for difference between "recovery mode" and "normal update mode", the document warns several times that a special "recovery mode" must be used or you risk bricking your device, yet it never explains what that actually is or how it differs from a normal mode, or what the normal mode is

3. Which SQNS firmware should be used https://software.pycom.io/downloads/sequans2.html ? No indication is given as to which version should be used, the most recent? or is there some special version that must be paired with the firmware on the board

All in all, the whole process took me multiple weeks with many hours of headscratching, and I'm not even sure it's working now because lte = LTE() hangs for >10min and my board seems to be bricked.

Why can't this whole process be handled by the Pycom Firmware Update tool so it "just works"? Sorry for ranting, it's just that I'm on the verge of returning this board because I've been trying to get it working on LTE with weeks of struggling and no luck.

>>> sqnsupgrade.run('/sd/CATM1-39529.dup', '/sd/updater.elf')
<<< Welcome to the SQN3330 firmware updater >>>
Attempting AT auto-negotiation...
Session opened: version 1, max transfer 2048 bytes
Sending 429340 bytes: [########################################] 100%
Attempting AT wakeup...
Upgrader loaded successfully, modem is in upgrade mode
Attempting AT wakeup...
Starting STP ON_THE_FLY
Session opened: version 1, max transfer 8192 bytes
Sending 6059510 bytes: [                                        ]   1%SRSP header too small: 0
Code download failed, aborting!

May be related to: pycom/pycom-libraries#81

[Xykon]

As per the documentation: Most importantly, the updater is now integrated in the latest stable firmware release

These libraries are NOT intended to be uploaded onto the module as they are integrated in the firmware. Trying to use these scripts, which are published only to be used on a PC when using the upgrade via uart method, with an incompatible MicroPython firmware will result in failures which can cause permanent damage to the modem.

[pirate]

Most importantly, the updater is now integrated in the latest stable firmware release

This sentence is still unclear, what part is the updater, only updater.elf or the .dup file, both? When is the uart method needed? Why have the docs up at all if they're not needed anymore?

[gijsio]

Hi,
I know it has been a while, but last week we updated the documentation in this respect. Let me know if it you still need it and if it is better now!