Migrate from L2 to L3 platform
Introduction
For customers who have used the L2 platform, migrating to the L3 platform will require some substantial changes in any interfacing software used. Some commands have been changed, and some new commands have been introduced. This quick-start section is intended to help guide users through these changes to ensure a smooth transition.
A few L2 commands have been deprecated, which means that they are no longer documented, but may still exist on the L3 platform to help users through the transition period. However, there is no guarantee that this will always be the case, so we strongly recommend that their use be discontinued as soon as possible.
Identifying the L3 platform
The L3 platform can be easily identified via the fwtype parameter of the id command.
In the case of the L3 platform, one would obtain:
>> id fwtype
<< id fwtype = 104
Whereas, in the case of the L2 platform, one would obtain:
>> id fwtype
<< id fwtype = 103
Deprecated commands
The following commands have been deprecated:
stop: replaced by the disable command
With L2 platform:CODE>> stop << stop = stopped
With L3 platform:
CODE>> disable << disable status = stopped
now: replaced by the clockcommand: see also the notes below about the clockcommand for other options
With L2 platform:CODE>> now << now = 20170901120000
With L3 platform:
CODE>> clock datetime << clock datetime = 20170901120000
starttime: replaced by the deployment command
endtime: replaced by the deployment command
status: replaced by the deploymentcommand
With L2 platform:CODE>> starttime << starttime = 20000101000000 >> endtime << endtime = 20991231235959 >> status << status = stopped
With L3 platform:
CODE>> deployment << deployment starttime = 20000101000000, endtime = 20991231235959, status = stopped
powerstatus: replaced by the power command. See also powerinternal and powerexternal commands
With L2 platform:
CODE>> powerstatus << powerstatus source = usb, int = 0.00, ext = 0.00, capacity = 24.000
With L3 platform:
CODE>> power << power source = usb, int = 12.40, ext = 0.00
read: replaced by the readdatacommand
With L2 platform:CODE>> read data 1 1000 2000 << data 1 12 2000<cr><lf><bytes[2000..2011]-of-data><crc>
With L3 platform:
CODE>> readdata dataset = 1, size = 1000, offset = 2000 << readdata dataset = 1, size = 12, offset = 2000<cr><lf><bytes[2000..2011]-of-data><crc>
Removed commands
errorlog
altitude: replaced by the settingscommand
With L2 platform:CODE>> altitude << altitude = 150.0 >> altitude = 0.26 << altitude = 0.26
With L3 platform:
CODE>> settings altitude << settings altitude = 150.0000 >> permit command = settings << permit command = settings >> settings altitude = 0.26 << settings altitude = 0.2600
Improved commands and new parameters
fetch: the fetch command allows now a specific subset of channels to be sampled
With L3 platform:
CODE>> fetch channels = 3|2 << 2017-10-21 11:50:49.000, 12.7052 dbar, 18.1745 C
powerinternal and powerexternal: track power usage.
With L3 platform:
CODE>> powerinternal << powerinternal batterytype = nimh, capacity = 138.0e+003, used = 100.1e+003 >> powerexternal << powerexternal batterytype = fermata_lisocl2, capacity = 22.0e+006, used = 100.1e+003
wifi: new parameters have been added.
With L2 platform:
CODE>> wifi << wifi timeout = 120, commandtimeout = 60
With L3 platform:
CODE>> wifi << wifi enabled = false, state = n/a, timeout = 120, commandtimeout = 60, baudrate = 921600
sampling: availablefastperiods parameter added
With L3 platform:
CODE>> sampling availablefastperiods << sampling availablefastperiods = 500|250|125|63
outputformat: support parameter renamed to availabletypes.Now uses pipe separation between list items
With L2 platform:
CODE>> outputformat support << outputformat support = caltext01, caltext02, caltext03, caltext04
With L3 platform:
CODE>> outputformat availabletypes << outputformat availabletypes = caltext01|caltext02|caltext03|caltext04
With L2 platform:
CODE>> outputformat channelslist << outputformat channelslist = temperature (C), pressure (dbar), pressure (dbar), depth (m)
With L3 platform:
CODE>> outputformat channelslist << outputformat channelslist = temperature(C)|pressure(dbar)|pressure(dbar)|depth(m)
deployment replaces the starttime, endtime, and status commands
enable: status is now reported as a key-value pair, and warnings reported via a parameter. Command does not fail if logging is already active.
With L2 platform:
CODE>> enable erasememory = true << E0401 estimated memory usage exceeds capacity, enable = logging
With L3 platform:
CODE>> enable erasememory = true << enable status = logging, warning = none >> enable erasememory = true << enable status = logging, warning = W0408
disable: status is now reported as a key-value pair. Command does not fail if logging not active.
With L2 platform:
CODE>> disable << disable = stopped
With L3 platform:
CODE>> disable << disable status = stopped
verify: status is now reported as a key-value pair and warning parameter added as well
With L2 platform:
CODE>> verify << verify = logging
With L3 platform:
CODE>> verify << verify status = logging, warning = none
clock: reports and sets the date and time as the datetime parameter and incorporates the UTC offset setting as the offsetfromutc parameter
With L2 platform:
CODE>> now << now = 20170901120000 >> now = 20170901155450 << now = 20170901155450
With L3 platform:
CODE>> clock << clock datetime = 20170901120000, offsetfromutc = +1.20 >> clock datetime = 20170901155450 << clock datetime = 20170901155450
link: type is now reported as a key-value pair
With L2 platform:
CODE>> link << link = usb
With L3 platform:
CODE>> link << link type = usb
permit: command is now received as a key-value pair
With L2 platform:
CODE>> permit memclear << permit = memclear
With L3 platform:
CODE>> permit command = memclear << permit command = memclear
memformat: support parameter renamed to availabletypes,uses pipe separation between list items
With L2 platform:
CODE>> memformat support << memformat support = rawbin00, calbin00
With L3 platform:
CODE>> memformat availabletypes << memformat availabletypes = rawbin00|calbin00
channels: latency parameter renamed to settlingtime
With L2 platform:
CODE>> channels latency << channels latency = 300
With L3 platform:
CODE>> channels settlingtime << channels settlingtime = 300
channel: all keyword replaced by allindices and alllabels. Added channel labels.
With L2 platform:
CODE>> channel all type << channel 1 type = temp01 | channel 2 type = pres24
With L3 platform:
CODE>> channel all type << E0108 invalid argument to command: 'all' >> channel allindices type << channel 1 type = temp01 || channel 2 type = pres24 >> channel alllabels type << channel temperature_00 type = temp09 || channel pressure_00 type = pres24
alibration: all keyword replaced by allindices and alllabels. Added channel labels
With L2 platform:
CODE>> calibration all datetime << calibration 1 datetime = 20171220161738 | calibration 2 datetime = 20171220161738
With L3 platform:
CODE>> calibration all datetime << E0108 invalid argument to command: 'all' >> calibration allindices datetime << calibration 1 datetime = 20171220161738 | calibration 2 datetime = 20171220161738 >> calibration alllabels datetime << calibration temperature_00 datetime = 20171220161738 | calibration pressure_00 datetime = 20171220161738
sensor: support allindices and alllabels keywords
getall: command added
info: command added
Removed parameters
sampling schedule
calibration type
Syntactical changes
Reference to channel via labels
CODE>> fetch channels = pressure01|temperature01 << 2017-10-21 11:50:49.000, 12.7052 dbar, 18.1745 C
|| instead of | for all, allindices, alllabels keywords
With L2 platform:CODE>> channel all type << channel 1 type = temp09 | channel 2 type = cond06
With L3 platform:
CODE>> channel alllabels type << channel temperature_00 type = temp09 || channel conductivity_00 type = cond06 >> channel allindices type << channel 1 type = temp09 || channel 2 type = cond06
Beside the command relying on alllabels and allindices, all commands now support the all keyword