dashboard

Documentation

Index

• func Delete(ctx context.Context, params *DeleteParams, cred *config.Credentials) error
• func Extract(ctx context.Context, params *ExtractParams, cred *config.Credentials) (map[string]interface{}, error)
• type CreateParams
• type DashboardInfo
  • func Create(ctx context.Context, params *CreateParams, cred *config.Credentials) (*DashboardInfo, error)
  • func List(ctx context.Context, cred *config.Credentials) ([]DashboardInfo, error)
• type DeleteParams
• type ExtractParams

Functions

func Delete

func Delete(ctx context.Context, params *DeleteParams, cred *config.Credentials) error

Delete command is used to delete a dashboard from Arduino IoT Cloud.

func Extract

func Extract(ctx context.Context, params *ExtractParams, cred *config.Credentials) (map[string]interface{}, error)

Extract command is used to extract a dashboard template from a dashboard on Arduino IoT Cloud.

Types

type CreateParams

type CreateParams struct {
	Name     *string           // Name of the new dashboard
	Override map[string]string // Template parameters to be overridden
	Template string            // Path of the template file
}

CreateParams contains the parameters needed to create a new dashboard.

type DashboardInfo

type DashboardInfo struct {
	Name      string   `json:"name"`
	ID        string   `json:"id"`
	UpdatedAt string   `json:"updated_at"`
	Widgets   []string `json:"widgets"`
}

DashboardInfo contains the most interesting information, in string format, of an Arduino IoT Cloud dashboard.

func Create

func Create(ctx context.Context, params *CreateParams, cred *config.Credentials) (*DashboardInfo, error)

Create allows to create a new dashboard.

func List

func List(ctx context.Context, cred *config.Credentials) ([]DashboardInfo, error)

List command is used to list the dashboards of Arduino IoT Cloud.

type DeleteParams

type DeleteParams struct {
	ID string
}

DeleteParams contains the parameters needed to delete a dashboard from Arduino IoT Cloud.

type ExtractParams

type ExtractParams struct {
	ID string
}

ExtractParams contains the parameters needed to extract a template dashboard from Arduino IoT Cloud.