Skip to content

Manage connection parameter for device create #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 27, 2023
Merged

Manage connection parameter for device create #131

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b58f5c6
Update the go client and manage connection parameter for device create
mirkokurt Jan 26, 2023
81dc2cd
Update Readme
mirkokurt Jan 26, 2023
870cc72
Update iot-client-go dependency
mirkokurt Jan 26, 2023
3716ed4
Go mod tidy
mirkokurt Jan 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .licenses/go/github.com/arduino/iot-client-go.dep.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: github.com/arduino/iot-client-go
version: v1.4.2
version: v1.4.4
type: go
summary:
homepage: https://pkg.go.dev/github.com/arduino/iot-client-go
Expand Down
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,21 @@ Here are the FQBNs of the Arduino boards that can be provisioned with this comma
* `arduino:samd:mkrgsm1400`
* `arduino:samd:mkrnb1500`

If the device supports more than one connectivity type (Eg: WiFi and Ethernet) the --connection flag can be used to set the desired connectivity

```bash
arduino-cloud-cli device create --name <deviceName> --port <port> --fqbn <deviceFqbn> --connection <deviceConnectivity>
```

Here the list of available connection values:

* `wifi` to set WiFi connectivity
* `eth` to set Ethernet connectivity
* `wifiandsecret`
* `gsm` to set Gsm connectivity
* `nb` to set Narrowband connectivity
* `lora` to set Lora connectivity

### Devices with LoRaWAN connectivity

LoRaWAN devices should be provisioned using a specific command.
Expand Down
11 changes: 8 additions & 3 deletions cli/device/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ import (
)

type createFlags struct {
port string
name string
fqbn string
port string
name string
fqbn string
ctype string
}

func initCreateCommand() *cobra.Command {
Expand All @@ -53,6 +54,7 @@ func initCreateCommand() *cobra.Command {
createCommand.Flags().StringVarP(&flags.port, "port", "p", "", "Device port")
createCommand.Flags().StringVarP(&flags.name, "name", "n", "", "Device name")
createCommand.Flags().StringVarP(&flags.fqbn, "fqbn", "b", "", "Device fqbn")
createCommand.Flags().StringVarP(&flags.ctype, "connection", "c", "", "Device connection type")
createCommand.MarkFlagRequired("name")
return createCommand
}
Expand All @@ -68,6 +70,9 @@ func runCreateCommand(flags *createFlags) error {
params := &device.CreateParams{
Name: flags.name,
}
if flags.ctype != "" {
params.ConnectionType = &flags.ctype
}
if flags.port != "" {
params.Port = &flags.port
}
Expand Down
9 changes: 5 additions & 4 deletions command/device/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ import (
// CreateParams contains the parameters needed
// to find the device to be provisioned.
type CreateParams struct {
Name string // Device name
Port *string // Serial port - Optional - If omitted then each serial port is analyzed
FQBN *string // Board FQBN - Optional - If omitted then the first device found gets selected
Name string // Device name
Port *string // Serial port - Optional - If omitted then each serial port is analyzed
FQBN *string // Board FQBN - Optional - If omitted then the first device found gets selected
ConnectionType *string // Connection type - Optional - If omitted then the default connection type (depends on the board type) get selected
}

// Create command is used to provision a new arduino device
Expand Down Expand Up @@ -70,7 +71,7 @@ func Create(ctx context.Context, params *CreateParams, cred *config.Credentials)
}

logrus.Info("Creating a new device on the cloud")
dev, err := iotClient.DeviceCreate(ctx, board.fqbn, params.Name, board.serial, board.dType)
dev, err := iotClient.DeviceCreate(ctx, board.fqbn, params.Name, board.serial, board.dType, params.ConnectionType)
if err != nil {
return nil, err
}
Expand Down
2 changes: 1 addition & 1 deletion command/device/creategeneric.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func CreateGeneric(ctx context.Context, params *CreateGenericParams, cred *confi
return nil, err
}

dev, err := iotClient.DeviceCreate(ctx, params.FQBN, params.Name, "", genericDType)
dev, err := iotClient.DeviceCreate(ctx, params.FQBN, params.Name, "", genericDType, nil)
if err != nil {
return nil, err
}
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ require (
github.com/arduino/board-discovery v0.0.0-20211020061712-fd83c2e3c908 // indirect
github.com/arduino/go-paths-helper v1.7.0
github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b
github.com/arduino/iot-client-go v1.4.2
github.com/arduino/iot-client-go v1.4.4
github.com/gofrs/uuid v4.2.0+incompatible
github.com/google/go-cmp v0.5.6
github.com/h2non/filetype v1.1.3 // indirect
Expand Down
2 changes: 2 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b h1:3PjgYG5g
github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b/go.mod h1:iIPnclBMYm1g32Q5kXoqng4jLhMStReIP7ZxaoUC2y8=
github.com/arduino/iot-client-go v1.4.2 h1:uZC8A26ytxSkuxNBFL2b/4w0TYjsR3ny2BbB5aVe4kw=
github.com/arduino/iot-client-go v1.4.2/go.mod h1:gYvpMt7Qw+OSScTLyIlCnpbvy9y96ey/2zhB4w6FoK0=
github.com/arduino/iot-client-go v1.4.4 h1:FICCXD5uCZ0scGG6RioOlpZamDqgSD1l/fQlFwKR284=
github.com/arduino/iot-client-go v1.4.4/go.mod h1:gYvpMt7Qw+OSScTLyIlCnpbvy9y96ey/2zhB4w6FoK0=
github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod h1:3U/XgcO3hCbHZ8TKRvWD2dDTCfh9M9ya+I9JpbB7O8o=
github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmVTwzkszR9V5SSuryQ31EELlFMUz1kKyl939pY=
github.com/armon/go-metrics v0.3.10/go.mod h1:4O98XIr/9W0sxpJ8UaYkvjk10Iff7SnFrb4QAOwNTFc=
Expand Down
10 changes: 8 additions & 2 deletions internal/iot/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ func NewClient(cred *config.Credentials) (*Client, error) {

// DeviceCreate allows to create a new device on Arduino IoT Cloud.
// It returns the newly created device, and an error.
func (cl *Client) DeviceCreate(ctx context.Context, fqbn, name, serial, dType string) (*iotclient.ArduinoDevicev2, error) {
func (cl *Client) DeviceCreate(ctx context.Context, fqbn, name, serial, dType string, cType *string) (*iotclient.ArduinoDevicev2, error) {
ctx, err := ctxWithToken(ctx, cl.token)
if err != nil {
return nil, err
Expand All @@ -60,6 +60,11 @@ func (cl *Client) DeviceCreate(ctx context.Context, fqbn, name, serial, dType st
Serial: serial,
Type: dType,
}

if cType != nil {
payload.ConnectionType = *cType
}

dev, _, err := cl.api.DevicesV2Api.DevicesV2Create(ctx, payload, nil)
if err != nil {
err = fmt.Errorf("creating device, %w", errorDetail(err))
Expand All @@ -85,7 +90,8 @@ func (cl *Client) DeviceLoraCreate(ctx context.Context, name, serial, devType, e
Type: devType,
UserId: "me",
}
dev, _, err := cl.api.LoraDevicesV1Api.LoraDevicesV1Create(ctx, payload)

dev, _, err := cl.api.LoraDevicesV1Api.LoraDevicesV1Create(ctx, payload, nil)
if err != nil {
err = fmt.Errorf("creating lora device: %w", errorDetail(err))
return nil, err
Expand Down