group

Usage

>> group [ count | maxcount | list ]

>> group <group_label> [channellist | schedulelist]

>> group create <group_label>

>> group delete <group_label> | all

Security

Open.

Description

This command is used to access information regarding all the channel groups configured within the instrument. Channel groups link instrument channels into a functional group for purpose of sampling. Groups can be created, deleted, accessed, and modified, however, they cannot be renamed. If renaming is required it is recommended to delete the group and create a new group with the appropriate label.

To access meta information about all groups which exist in the instrument, the group command can be used without any arguments. The instrument will respond with the following parameters:

• count - reports the number of groups currently defined.

• maxcount - reports the maximum number of groups that the instrument can hold in its pool at any given time.

• list - reports a list of all the defined group labels; labels in the list are separated by a pipe character (“|”), with no spaces.  Labels are reported in the order that the groups were created, earliest first.

>> group
<< group count=3 maxcount=16 list=g.ctd|g.optical|g.chemical

To access parameters for a specific group, provide the <group_label> as an argument to the group command. The following parameters are available for a given group:

• channellist reports a list of logger channels that are included in this group.  Labels in the list must be separated by a pipe character (“|”), with no spaces.  The list must specify at least one channel for the group to be valid. Specifying the keyword none, by itself, in place of a list of channel labels, will clear the channel list for the group.

• schedulelist is a read-only parameter that reports a list of all the schedules currently in the pool which use this group.  Any group usage for historical datasets stored in the logger's memory is not included.  Labels in the list are separated by a pipe character (“|”), with no spaces.  If the group is unused by any schedules, this list is replaced by the word none.

>> group salinity_grp
<< group salinity_grp channellist=conductivity_00 schedulelist=none

If only a single parameter is needed, it can be requested by providing the key for that parameter as an argument to the group specified by the <group_label>.

>> group salinity_grp schedulelist
<< group salinity_grp schedulelist=none

>> group salinity_grp channellist
<< group salinity_grp channellist=conductivity_00

Modifications can only be performed on a single group at a time. To perform a modification, provide the <group_label> as an argument to the group command then provide the key/value pairing for the value to be changed. There is only one available key which can be modified and it is:

• channellist [=<channel_label_list ...>] sets a list of logger channels that are included in this group.  Labels in the list must be separated by a pipe character (“|”), with no spaces.  The list must specify at least one channel for the group to be valid. Specifying the keyword none, by itself, in place of a list of channel labels, will clear the channel list for the group.

>> group salinity_grp channellist=conductivity_00|temperature_00|pressure_00
<< group salinity_grp channellist=conductivity_00|temperature_00|pressure_00

>> group salinity_grp channellist=salinity_00|conductivity_00|temperature_00|pressure_00|temperature_01
<< group salinity_grp channellist=salinity_00|conductivity_00|temperature_00|pressure_00|temperature_01

create

Usage

>> group create <group_label>

Security

Unsafe - groups may not be created while logging is enabled.

Description

Groups can be created the create action within the group command. The group label must be specified as an argument to the action.

>> group create g.pressure
<< group create g.pressure

>> group
<< group count=4 maxcount=16 list=g.ctd|g.optical|g.chemical|g.pressure

delete

Usage

>> group delete <group_label> | all

Security

Unsafe - groups may not be deleted while logging is enabled.

Description

Deletes one or all groups.  Groups are specified by their labels.  At least one existing group must be specified.  The parameters are as follows:

• <group_label> specifies by label a single group to delete from the pool.

• all causes all user-defined groups to be deleted from the pool.

A deleted group can no longer be used by any schedule.  Any schedule in the pool of schedules which used the deleted group will automatically have the group removed from its list.  Historical datasets in the logger memory are not affected when a group is deleted; the configuration snapshot saved in the dataset's metadata includes all group details at the time the logger was enabled.

>> group
<< group count=4 maxcount=16 list=g.ctd|g.optical|g.chemical|g.pressure

>> group delete g.optical
<< group delete g.optical

>> group
<< group count=3 maxcount=16 list=g.ctd|g.chemical|g.pressure

Deleting g.optical removes it from the pool and reduces the count by one.

>> group
<< group count=3 maxcount=16 list=g.ctd|g.chemical|g.pressure

>> group delete all
<< group delete all

>> group
<< group count=0 maxcount=16 list=none

Deleting all groups removes all items from the pool and reduces the count to zero. The schedule list will indicate it is empty with the value of none.