device

module

v2.5.1 Latest Latest Go to latest Published: May 14, 2024 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/plgd-dev/device

Links

Open Source Insights

README ¶

Device

The client enables interaction with devices in a local network:

Listing devices
Retrieving and updating resources
Secure ownership transfer via coaps+tcp and coaps
Onboard and offboard device
Provisioning the cloud resource and credentials

Requirements

Go 1.22 or higher

Installation OCF Client

go install github.com/plgd-dev/device/v2/cmd/ocfclient@latest

Directories ¶

Path	Synopsis
bridge
device
device/cloud
device/credential
device/thingDescription
net
resources
resources/cloud
resources/device
resources/discovery
resources/maintenance
resources/secure/credential
resources/thingDescription
service
test
client
app
core
core/otm
core/otm/just-works
core/otm/just-works/cipher
core/otm/manufacturer
cmd
bridge-device
bridge-device/device
ocfclient
pkg
codec/cbor
codec/json
codec/ocf
error
eventloop
log
net/coap
ocf/cloud
security/generateCertificate
security/signer
security/x509
schema ResourceLink provides a link for retrieving details for its resource types: https://github.com/openconnectivityfoundation/core/blob/OCF-v2.0.0/schemas/oic.oic-link-schema.json	ResourceLink provides a link for retrieving details for its resource types: https://github.com/openconnectivityfoundation/core/blob/OCF-v2.0.0/schemas/oic.oic-link-schema.json
account Package account implements the Account Token resource.	Package account implements the Account Token resource.
acl Package acl implements the Access Control List resource.	Package acl implements the Access Control List resource.
ael Auditable Event List https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.ael.swagger.json	Auditable Event List https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.ael.swagger.json
cloud Package cloud implements Cloud Configuration Resource.	Package cloud implements Cloud Configuration Resource.
collection Collection https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.col.swagger.json	Collection https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.col.swagger.json
configuration Device Configuration https://github.com/openconnectivityfoundation/core-extensions/blob/master/swagger2.0/oic.wk.con.swagger.json	Device Configuration https://github.com/openconnectivityfoundation/core-extensions/blob/master/swagger2.0/oic.wk.con.swagger.json
credential Credential https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.cred.swagger.json	Credential https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.cred.swagger.json
csr Certificate Signing Request https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.csr.swagger.json	Certificate Signing Request https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.csr.swagger.json
device Device info.	Device info.
doxm Device Owner Transfer Method https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.doxm.swagger.json	Device Owner Transfer Method https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.doxm.swagger.json
interfaces
introspection Introspection Resource https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.introspection.swagger.json	Introspection Resource https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.introspection.swagger.json
maintenance
platform Platform info https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.p.swagger.json	Platform info https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.p.swagger.json
plgdtime
pstat Package pstat implements Device Provisioning Status resource.	Package pstat implements Device Provisioning Status resource.
resources Discoverable Resources https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.res.swagger.json	Discoverable Resources https://github.com/openconnectivityfoundation/core/blob/master/swagger2.0/oic.wk.res.swagger.json
roles Asserted Roles https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.roles.swagger.json	Asserted Roles https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.roles.swagger.json
sdi Security Domain Information https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.sdi.swagger.json	Security Domain Information https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.sdi.swagger.json
session Session Resource that manages the persistent session between a Device and OCF Cloud.	Session Resource that manages the persistent session between a Device and OCF Cloud.
softwareupdate
sp Security Profile https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.sp.swagger.json	Security Profile https://github.com/openconnectivityfoundation/security/blob/master/swagger2.0/oic.sec.sp.swagger.json
test
client
coap-gateway
coap-gateway/service
resource/types

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