nuttx-apps/system/cfgdata/README.md

# System / `cfgdata`

```
Author: Ken Pettit
  Date: 18 December 2018
```

This application provides a command line interface for managing platform
specific configdata within the `/dev/config` device.

**Usage**:

```shell
config <cmd> [arguments]
```

Where `<cmd>` is one of:

- `all` – show all config entries
- `print` – display a specific config entry
- `set` – set or change a config entry
- `unset` – delete a config entry
-												Rewritten READMEs to Markdown

											
										
										
											2020-07-23 15:19:35 +02:00
+								# System / `cfgdata`
-												apps/system/configdata:  Adds an "cfgdata" command which allows manipulation of the /dev/config items via the command line.  One such use for this utility would be to set a "macaddr" configdata item, etc.  The utility is sort-of like a u-boot env variable edit function:

For instance, to set a "macaddr" when the new CONFIG_MTD_CONFIG_NAMED option is selected, you would do:

nsh> cfgdata set macaddr [0xfc 0x01 0x0b 0x45 0xa1 0x12] <-- brackets denotes an array of bytes
nsh> cfgdata set hostname myboard

or using the old ID,INSTANCE numeric method:

nsh> cfgdata set 0,0 [0xfc 0x01 0x0b 0x45 0xa1 0x12]      <-- brackets denotes an array of bytes
nsh> cfgdata set 1,0 myboard

You can also display all config items:

nsh> cfgdata print all
Name                    Len   Data
macaddr                 6     0xFC 0x01 0x0B 0x45 0xA1 0x12
hostname                8     myboard

											
										
										
											2018-12-20 21:24:51 +01:00
-												Rewritten READMEs to Markdown

											
										
										
											2020-07-23 15:19:35 +02:00
+								```
 								Author: Ken Pettit
 								  Date: 18 December 2018
 								```
-												apps/system/configdata:  Adds an "cfgdata" command which allows manipulation of the /dev/config items via the command line.  One such use for this utility would be to set a "macaddr" configdata item, etc.  The utility is sort-of like a u-boot env variable edit function:

For instance, to set a "macaddr" when the new CONFIG_MTD_CONFIG_NAMED option is selected, you would do:

nsh> cfgdata set macaddr [0xfc 0x01 0x0b 0x45 0xa1 0x12] <-- brackets denotes an array of bytes
nsh> cfgdata set hostname myboard

or using the old ID,INSTANCE numeric method:

nsh> cfgdata set 0,0 [0xfc 0x01 0x0b 0x45 0xa1 0x12]      <-- brackets denotes an array of bytes
nsh> cfgdata set 1,0 myboard

You can also display all config items:

nsh> cfgdata print all
Name                    Len   Data
macaddr                 6     0xFC 0x01 0x0B 0x45 0xA1 0x12
hostname                8     myboard

											
										
										
											2018-12-20 21:24:51 +01:00
-												Rewritten READMEs to Markdown

											
										
										
											2020-07-23 15:19:35 +02:00
+								This application provides a command line interface for managing platform
 								specific configdata within the `/dev/config` device.
-												apps/system/configdata:  Adds an "cfgdata" command which allows manipulation of the /dev/config items via the command line.  One such use for this utility would be to set a "macaddr" configdata item, etc.  The utility is sort-of like a u-boot env variable edit function:

For instance, to set a "macaddr" when the new CONFIG_MTD_CONFIG_NAMED option is selected, you would do:

nsh> cfgdata set macaddr [0xfc 0x01 0x0b 0x45 0xa1 0x12] <-- brackets denotes an array of bytes
nsh> cfgdata set hostname myboard

or using the old ID,INSTANCE numeric method:

nsh> cfgdata set 0,0 [0xfc 0x01 0x0b 0x45 0xa1 0x12]      <-- brackets denotes an array of bytes
nsh> cfgdata set 1,0 myboard

You can also display all config items:

nsh> cfgdata print all
Name                    Len   Data
macaddr                 6     0xFC 0x01 0x0B 0x45 0xA1 0x12
hostname                8     myboard

											
										
										
											2018-12-20 21:24:51 +01:00
-												Rewritten READMEs to Markdown

											
										
										
											2020-07-23 15:19:35 +02:00
+								**Usage**:
-												apps/system/configdata:  Adds an "cfgdata" command which allows manipulation of the /dev/config items via the command line.  One such use for this utility would be to set a "macaddr" configdata item, etc.  The utility is sort-of like a u-boot env variable edit function:

For instance, to set a "macaddr" when the new CONFIG_MTD_CONFIG_NAMED option is selected, you would do:

nsh> cfgdata set macaddr [0xfc 0x01 0x0b 0x45 0xa1 0x12] <-- brackets denotes an array of bytes
nsh> cfgdata set hostname myboard

or using the old ID,INSTANCE numeric method:

nsh> cfgdata set 0,0 [0xfc 0x01 0x0b 0x45 0xa1 0x12]      <-- brackets denotes an array of bytes
nsh> cfgdata set 1,0 myboard

You can also display all config items:

nsh> cfgdata print all
Name                    Len   Data
macaddr                 6     0xFC 0x01 0x0B 0x45 0xA1 0x12
hostname                8     myboard

											
										
										
											2018-12-20 21:24:51 +01:00
-												Rewritten READMEs to Markdown

											
										
										
											2020-07-23 15:19:35 +02:00
+								```shell
 								config <cmd> [arguments]
 								```
 								Where `<cmd>` is one of:
 								- `all` – show all config entries
 								- `print` – display a specific config entry
 								- `set` – set or change a config entry
 								- `unset` – delete a config entry