Skip to content

EdgeX Foundry Documentation

Swagger API Documentation

Initializing search

Introduction
Getting Started
Security
Microservices
Examples and Tutorials
API Reference
Use Cases & Designs
Reference

EdgeX Foundry Documentation

Introduction
Introduction
- Introduction
- V3 Migration Guide
Getting Started
Getting Started
- Getting Started
- Quick Start
- Users
  Users
- Developers
  Developers
  - Getting Started as a Developer
  - Getting Started - Go Developers
  - Getting Started - C Developers
  - Working in a Hybrid Environment
  - Native Build and Run Guides
    Native Build and Run Guides
    
    Native Build and Run
    
    Build and Run on Linux on x86/x64
    
    Build and Run on Linux on ARM 32
    
    Build and Run on Windows on x86/x64
  - Application Functions SDK
  - Device Services
    Device Services
    
    Device Service SDK
    
    C SDK
    
    Golang SDK
  - Getting Docker Images from EdgeX Nexus Repository
  - DTO Validation
- Tools
  Tools
  - Graphical User Interface (GUI)
Security
Security
Microservices
Microservices
- Cross Cutting Concerns
- Configuration & Registry
  Configuration & Registry
- EdgeX MessageBus
- Core Services
  Core Services
- Supporting Services
  Supporting Services
- Devices Services
  Devices Services
  - Device Services Microservices
  - Device Profile
  - Device Services SDK
  - Device SDK API
    Device SDK API
    
    Go Device SDK API
  - Supported Device Services
    Supported Device Services
    
    Supported Device Services List
    
    Device Onvif Camera
    Device Onvif Camera
    
    General
    
    Walkthrough
    Walkthrough
    
    Setup
    
    Deployment
    
    General Usage
    
    Custom Build
    
    Swagger API Documentation
    
    Supplementary Information
    Supplementary Information
    
    ONVIF Protocol
    ONVIF Protocol
    
    Onvif Camera Device Service Specifications
    
    Onvif User Authentication
    
    Features
    Features
    
    Custom Metadata
    
    Friendly Name and MAC Address
    
    Device Status
    
    Auto Discovery
    
    Credentials
    
    RebootNeeded
    
    API Reference
    API Reference
    
    Analytic Support
    
    Event Handling
    
    User Handling
    
    Utility
    Utility
    
    Test with Postman
    
    Utility Scripts
    
    Miscellaneous
    Miscellaneous
    
    Control Plane Events
    
    Getting Started With Docker (Security Mode)
    
    How does WS-Discovery work?
    
    ONVIF Footnotes
    
    Device USB Camera
    Device USB Camera
    
    General
    
    Walkthrough
    Walkthrough
    
    Setup
    
    Deployment
    
    General Usage
    
    Custom Build
    
    Supplementary Information
    Supplementary Information
    
    Dynamic Discovery
    
    Advanced Options
    
    Device Virtual
    Device Virtual
    
    Device Virtual
  - V3 Migration Guide
- Application Services
  Application Services
  - Introduction
  - Getting Started
  - Triggers
  - Application Functions SDK
    Application Functions SDK
    
    App Functions SDK Introduction
    
    Application Service API
    
    App Function Context API
    
    Pipeline Function Error Handling
    
    Built-In Pipeline Functions
    
    Advanced Topics
  - App Service Configurable
  - Application Service Configuration
  - V3 Migration Guide
Examples and Tutorials
Examples and Tutorials
- EdgeX Examples
- Using the Virtual Device Service
- Sending and Consuming Binary Data From EdgeX Device Services
- App Service Examples
  App Service Examples
  - App Service Examples
  - Camera Management Example App Service
- Command Devices with eKuiper Rules Engine
- Modbus - Data Type Conversion
- Creating an EdgeX Ubuntu Core Image
- Adding a Device
  Adding a Device
  - Modbus
  - SNMP
  - MQTT
- Walkthrough
  Walkthrough
API Reference
API Reference
Use Cases & Designs
Use Cases & Designs
- Use Cases and Design Process
- Use Cases and Design Records
- Legacy
  Legacy
  - Legacy Design Documents
  - Legacy Requirements
Reference
Reference

Swagger API Documentation

Use this RESTful API documentation to learn more about the capabilities of the device service.

Previous Custom Build

Next Onvif Camera Device Service Specifications

Copyright © 2022 EdgeX Foundry

Made with Material for MkDocs