client

package

Go to main page

Versions in this module

v2

v2.5.1

May 14, 2024

v2.5.0

Apr 19, 2024

v2.4.4

Apr 2, 2024

v2.4.3

Mar 27, 2024

v2.4.2

Mar 26, 2024

v2.4.1

Mar 26, 2024

v2.4.0

Mar 14, 2024

v2.3.1

Feb 21, 2024

v2.3.0

Feb 3, 2024

Changes in this version

type Client

+ func (c *Client) GetDevicesByIP(ctx context.Context, ip string) ([]DeviceWithLinks, error)

type ClientConfig

+ UseDeviceIDInQuery bool

type ClientOptionFunc

+ func WithUseDeviceIDInQuery(useDeviceIDInQuery bool) ClientOptionFunc

type Config

+ UseDeviceIDInQuery bool

+ type DeviceWithLinks struct

+ Device *core.Device

+ Links schema.ResourceLinks

type ResourceQueryOption

+ func WithDeviceID(deviceID string) ResourceQueryOption

+ type UseDeviceIDInQueryOption struct

+ UseDeviceID bool

+ func WithUseDeviceID(useDeviceID bool) UseDeviceIDInQueryOption

v2.2.4

Dec 15, 2023

v2.2.3

Dec 8, 2023

v2.2.2

Oct 10, 2023

v2.2.1

Oct 2, 2023

Changes in this version

+ type ResourceETagOption struct

+ func WithETag(etag []byte) ResourceETagOption

+ type ResourceQueryOption struct

+ func WithQuery(resourceQuery string) ResourceQueryOption

v2.2.0

May 4, 2023

v2.1.0

Feb 10, 2023

Changes in this version

+ type ClientConfig struct

+ CacheExpiration time.Duration

+ CoreOptions []core.OptionFunc

+ Observer ObserverConfig

+ type ClientOptionFunc func(ClientConfig) ClientConfig

+ func WithCacheExpiration(cacheExpiration time.Duration) ClientOptionFunc

+ func WithDialDTLS(dial core.DialDTLS) ClientOptionFunc

+ func WithDialTCP(dial core.DialTCP) ClientOptionFunc

+ func WithDialTLS(dial core.DialTLS) ClientOptionFunc

+ func WithDialUDP(dial core.DialUDP) ClientOptionFunc

+ func WithLogger(logger core.Logger) ClientOptionFunc

+ func WithObserverConfig(observerConfig ObserverConfig) ClientOptionFunc

+ func WithTLS(tlsConfig *core.TLSConfig) ClientOptionFunc

type Config

+ ObserverFailureThreshold uint8

+ type ObserverConfig struct

+ FailureThreshold uint8

+ PollingInterval time.Duration

v2.0.5

Feb 6, 2023

v2.0.4

Jan 25, 2023

v2.0.3

Jan 10, 2023

v2.0.2

Jan 9, 2023

Changes in this version

type Client

+ func (c *Client) GetDevicesDetails(ctx context.Context, opts ...GetDevicesOption) (map[string]DeviceDetails, error)

v2.0.1

Nov 7, 2022

Changes in this version

type OwnOption

+ func WithActionAfterOwn(...) OwnOption

v2.0.0

Oct 14, 2022

Changes in this version

+ func GenerateSDKIdentityCertificate(ctx context.Context, sign SignFunc, sdkDeviceID string) (tls.Certificate, []*x509.Certificate, error)

+ func GenerateSDKManufacturerCertificate(ctx context.Context, sign SignFunc, id string) (tls.Certificate, []*x509.Certificate, error)

+ func NewDeviceOwnershipBackendFromConfig(app ApplicationCallback, dialTLS core.DialTLS, dialDTLS core.DialDTLS, ...) (*deviceOwnershipBackend, error)

+ func NewDeviceOwnershipNone() *deviceOwnershipNone

+ func NewDeviceOwnershipSDK(app ApplicationCallback, sdkDeviceID string, dialTLS core.DialTLS, ...) (*deviceOwnershipSDK, error)

+ func NewDeviceOwnershipSDKFromConfig(app ApplicationCallback, dialTLS core.DialTLS, dialDLTS core.DialDTLS, ...) (*deviceOwnershipSDK, error)

+ func TokenFromOutgoingMD(ctx context.Context) (string, error)

+ type ApplicationCallback = interface

+ GetManufacturerCertificate func() (tls.Certificate, error)

+ GetManufacturerCertificateAuthorities func() ([]*x509.Certificate, error)

+ GetRootCertificateAuthorities func() ([]*x509.Certificate, error)

+ type Client struct

+ func NewClient(app ApplicationCallback, deviceOwner DeviceOwner, ...) (*Client, error)

+ func NewClientFromConfig(cfg *Config, app ApplicationCallback, logger core.Logger) (*Client, error)

+ func (c *Client) Close(ctx context.Context) error

+ func (c *Client) CoreClient() *core.Client

+ func (c *Client) CreateResource(ctx context.Context, deviceID string, href string, request interface{}, ...) error

+ func (c *Client) DeleteDevice(ctx context.Context, deviceID string) bool

+ func (c *Client) DeleteDevices(ctx context.Context, deviceIDFilter []string) []string

+ func (c *Client) DeleteResource(ctx context.Context, deviceID string, href string, response interface{}, ...) error

+ func (c *Client) DisownDevice(ctx context.Context, deviceID string, opts ...CommonCommandOption) error

+ func (c *Client) FactoryReset(ctx context.Context, deviceID string, opts ...CommonCommandOption) error

+ func (c *Client) GetAllDeviceIDsFoundByIP() map[string]string

+ func (c *Client) GetDevice(ctx context.Context, deviceID string, opts ...GetDeviceOption) (*core.Device, schema.ResourceLinks, error)

+ func (c *Client) GetDeviceByIP(ctx context.Context, ip string) (*core.Device, schema.ResourceLinks, error)

+ func (c *Client) GetDeviceByMulticast(ctx context.Context, deviceID string, opts ...GetDeviceOption) (*core.Device, schema.ResourceLinks, error)

+ func (c *Client) GetDeviceDetailsByIP(ctx context.Context, ip string, opts ...GetDeviceByIPOption) (DeviceDetails, error)

+ func (c *Client) GetDeviceDetailsByMulticast(ctx context.Context, deviceID string, opts ...GetDeviceOption) (DeviceDetails, error)

+ func (c *Client) GetDevices(ctx context.Context, opts ...GetDevicesOption) (map[string]DeviceDetails, error)

+ func (c *Client) GetDevicesWithHandler(ctx context.Context, handler core.DeviceMulticastHandler, ...) error

+ func (c *Client) GetIdentityCACerts() ([]*x509.Certificate, error)

+ func (c *Client) GetIdentityCertificate() (tls.Certificate, error)

+ func (c *Client) GetResource(ctx context.Context, deviceID string, href string, response interface{}, ...) error

+ func (c *Client) Initialization(ctx context.Context) (err error)

+ func (c *Client) ObserveDeviceResources(ctx context.Context, deviceID string, ...) (string, error)

+ func (c *Client) ObserveDevices(ctx context.Context, handler DevicesObservationHandler, ...) (string, error)

+ func (c *Client) ObserveResource(ctx context.Context, deviceID string, href string, ...) (observationID string, _ error)

+ func (c *Client) OffboardDevice(ctx context.Context, deviceID string, opts ...CommonCommandOption) error

+ func (c *Client) OnboardDevice(ctx context.Context, ...) error

+ func (c *Client) OwnDevice(ctx context.Context, deviceID string, opts ...OwnOption) (string, error)

+ func (c *Client) Reboot(ctx context.Context, deviceID string, opts ...CommonCommandOption) error

+ func (c *Client) StopObservingDeviceResources(ctx context.Context, observationID string) (bool, error)

+ func (c *Client) StopObservingDevices(ctx context.Context, observationID string) bool

+ func (c *Client) StopObservingResource(ctx context.Context, observationID string) (bool, error)

+ func (c *Client) UpdateResource(ctx context.Context, deviceID string, href string, request interface{}, ...) error

+ type CodecOption struct

+ func WithCodec(codec coap.Codec) CodecOption

+ type CommonCommandOption = interface

+ type Config struct

+ DefaultTransferDurationSeconds uint64

+ DeviceCacheExpirationSeconds int64

+ DeviceOwnershipBackend *DeviceOwnershipBackendConfig

+ DeviceOwnershipSDK *DeviceOwnershipSDKConfig

+ DisablePeerTCPSignalMessageCSMs bool

+ KeepAliveConnectionTimeoutSeconds uint64

+ MaxMessageSize uint32

+ ObserverPollingIntervalSeconds uint64

+ type CreateOption = interface

+ type DeleteOption = interface

+ type DeviceCache struct

+ func NewDeviceCache(deviceExpiration, pollInterval time.Duration, logger core.Logger) *DeviceCache

+ func (c *DeviceCache) Close(ctx context.Context) error

+ func (c *DeviceCache) GetDevice(deviceID string) (*core.Device, bool)

+ func (c *DeviceCache) GetDeviceByFoundIP(ip string) *core.Device

+ func (c *DeviceCache) GetDeviceExpiration(deviceID string) (time.Time, bool)

+ func (c *DeviceCache) GetDevicesFoundByIP() map[string]string

+ func (c *DeviceCache) LoadAndDeleteDevice(deviceID string) (*core.Device, bool)

+ func (c *DeviceCache) LoadAndDeleteDevices(deviceIDFilter []string) []*core.Device

+ func (c *DeviceCache) TryToChangeDeviceExpirationToDefault(deviceID string) bool

+ func (c *DeviceCache) UpdateOrStoreDevice(device *core.Device) (*core.Device, bool)

+ func (c *DeviceCache) UpdateOrStoreDeviceWithExpiration(device *core.Device) (*core.Device, bool)

+ type DeviceDetails struct

+ Details interface{}

+ Endpoints []schema.Endpoint

+ FoundByIP string

+ ID string

+ IsSecured bool

+ Ownership *doxm.Doxm

+ OwnershipStatus OwnershipStatus

+ Resources []schema.ResourceLink

+ type DeviceOwner interface

+ GetIdentityCACerts func() ([]*x509.Certificate, error)

+ GetIdentityCertificate func() (tls.Certificate, error)

+ Initialization func(ctx context.Context) error

+ OwnDevice func(ctx context.Context, deviceID string, otmTypes []OTMType, ...) (string, error)

+ func NewDeviceOwnerFromConfig(cfg *Config, dialTLS core.DialTLS, dialDTLS core.DialDTLS, ...) (DeviceOwner, error)

+ type DeviceOwnershipBackendConfig struct

+ JWTClaimOwnerID string

+ Sign SignFunc

+ type DeviceOwnershipSDKConfig struct

+ Cert string

+ CertExpiry *string

+ CertKey string

+ CreateSignerFunc func(caCert []*x509.Certificate, caKey crypto.PrivateKey, validNotBefore time.Time, ...) core.CertificateSigner

+ ID string

+ ValidFrom string

+ type DeviceResourcesObservationHandler = interface

+ Error func(err error)

+ Handle func(ctx context.Context, links schema.ResourceLinks) error

+ OnClose func()

+ type DevicesObservationEvent struct

+ DeviceID string

+ Event DevicesObservationEvent_type

+ type DevicesObservationEvent_type uint8

+ const DevicesObservationEvent_OFFLINE

+ const DevicesObservationEvent_ONLINE

+ type DevicesObservationHandler = interface

+ Error func(err error)

+ Handle func(ctx context.Context, event DevicesObservationEvent) error

+ OnClose func()

+ type DiscoveryConfigurationOption struct

+ func WithDiscoveryConfiguration(cfg core.DiscoveryConfiguration) DiscoveryConfigurationOption

+ type GetDetailsFunc = func(context.Context, *core.Device, schema.ResourceLinks) (interface{}, error)

+ type GetDetailsOption struct

+ func WithGetDetails(...) GetDetailsOption

+ type GetDeviceByIPOption = interface

+ type GetDeviceOption = interface

+ type GetDevicesOption = interface

+ type GetDevicesWithHandlerOption = interface

+ type GetOption = interface

+ type OTMType int

+ const OTMType_JustWorks

+ const OTMType_Manufacturer

+ type ObserveDevicesOption = interface

+ type ObserveOption = interface

+ type OwnOption = interface

+ func WithActionAftersOwn(...) OwnOption

+ func WithActionDuringOwn(...) OwnOption

+ func WithOTM(otmType OTMType) OwnOption

+ func WithOTMs(otmTypes []OTMType) OwnOption

+ func WithPresharedKey(presharedKey []byte) OwnOption

+ type OwnershipStatus string

+ const OwnershipStatus_Owned

+ const OwnershipStatus_OwnedByOther

+ const OwnershipStatus_ReadyToBeOwned

+ const OwnershipStatus_Unknown

+ type ResourceInterfaceOption struct

+ func WithInterface(resourceInterface string) ResourceInterfaceOption

+ type ResourceTypesOption struct

+ func WithResourceTypes(resourceTypes ...string) ResourceTypesOption

+ type SignFunc = func(ctx context.Context, csr []byte) (signedCsr []byte, err error)

+ type Signer = interface

+ Sign func()

+ type UpdateOption = interface

Other modules containing this package

github.com/plgd-dev/device

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL