├── .blubracket └── ignore.yaml ├── .github ├── Contributing.md ├── PULL_REQUEST_TEMPLATE.md └── semantic.yml ├── .gitignore ├── Dockerfile.docs ├── GOVERNANCE.md ├── Jenkinsfile ├── Makefile ├── OWNERS.md ├── README.md ├── docs ├── 404.html ├── CNAME ├── index.html ├── robots.txt └── versions.json ├── docs_src ├── V3TopLevelMigration.md ├── about.md ├── api │ ├── Ch-APIIntroduction.md │ ├── applications │ │ └── Ch-APIRulesEngine.md │ ├── core │ │ ├── Ch-APICoreCommand.md │ │ ├── Ch-APICoreConfigurationAndRegistry.md │ │ ├── Ch-APICoreKeeper.md │ │ ├── Ch-APICoreMetadata.md │ │ └── Ch-APICoredata.md │ ├── devices │ │ └── Ch-APIDeviceSDK.md │ └── support │ │ ├── Ch-APISupportNotifications.md │ │ └── Ch-APISupportScheduler.md ├── assets │ ├── javascripts │ │ └── version-select.js │ ├── logo_edgex.png │ ├── logo_edgex_white.png │ └── stylesheets │ │ ├── branding.css │ │ ├── edgey.css │ │ ├── extra.css │ │ ├── newexample.css │ │ └── version-select.css ├── cloud-upload.png ├── design │ ├── Process.drawio.xml │ ├── Process.md │ ├── Process.png │ ├── TOC.md │ ├── adr │ │ ├── 0001-Registy-Refactor.md │ │ ├── 0004-Feature-Flags.md │ │ ├── 0005-Service-Self-Config.md │ │ ├── 0006-Metrics-Collection.md │ │ ├── 0018-Service-Registry.md │ │ ├── 0023-North-South-Messaging.md │ │ ├── 0024-system-events.md │ │ ├── 0026-Common Configuration.md │ │ ├── 0027-URIs for Files.md │ │ ├── 0030-Performance-Test-Harness.md │ │ ├── 013-Device-Service-Events-Message-Bus.md │ │ ├── 014-Secret-Provider-For-All.md │ │ ├── README.md │ │ ├── application │ │ │ ├── .gitignore │ │ │ └── 0025-Record-and-Replay.md │ │ ├── command-message-bridge.png │ │ ├── command-msg-structure.png │ │ ├── command-msg.png │ │ ├── command-service-topics.png │ │ ├── common-config-images │ │ │ ├── EdgeX 2.x Configuration bootstrapping flowchart.drawio │ │ │ ├── EdgeX 2.x Configuration bootstrapping flowchart.png │ │ │ ├── EdgeX 3.x Common Configuration bootstrapping flowchart.drawio │ │ │ ├── EdgeX 3.x Common Configuration bootstrapping flowchart.png │ │ │ ├── EdgeX 3.x Configuration bootstrapping flowchart.drawio │ │ │ └── EdgeX 3.x Configuration bootstrapping flowchart.png │ │ ├── core │ │ │ ├── .gitignore │ │ │ ├── 0003-V2-API-Principles.md │ │ │ ├── 0019-EdgeX-CLI-V2.md │ │ │ ├── 0021-Device-Profile-Changes.md │ │ │ ├── 0022-UoM.md │ │ │ └── EdgeX_UoM_Validation.png │ │ ├── device-service │ │ │ ├── .gitignore │ │ │ ├── 0002-Array-Datatypes.md │ │ │ ├── 0011-DeviceService-Rest-API.md │ │ │ └── 0012-DeviceService-Filters.md │ │ ├── devops │ │ │ ├── .gitignore │ │ │ ├── 0007-Release-Automation.md │ │ │ ├── 0007 │ │ │ │ ├── gomods_mergeactions.png │ │ │ │ ├── gomods_releaseactions.png │ │ │ │ ├── mergeactions.png │ │ │ │ └── releaseactions.png │ │ │ ├── 0010-Release-Artifacts.md │ │ │ └── 0010 │ │ │ │ └── known-build-dependencies.png │ │ ├── performance-report.png │ │ ├── security │ │ │ ├── .gitignore │ │ │ ├── 0008-Secret-Creation-and-Distribution.md │ │ │ ├── 0009-Secure-Bootstrapping.md │ │ │ ├── 0015-in-cluster-tls.md │ │ │ ├── 0016-docker-image-guidelines.md │ │ │ ├── 0017-consul-security.md │ │ │ ├── 0020-spiffe-architecture.jpg │ │ │ ├── 0020-spiffe.md │ │ │ ├── 0028-as-is.jpg │ │ │ ├── 0028-authentication.md │ │ │ ├── 0028-to-be.jpg │ │ │ ├── 0029-as-is.jpg │ │ │ ├── 0029-authentication-e2ee.md │ │ │ ├── 0029-to-be.jpg │ │ │ ├── bootstrap-as-is.jpg │ │ │ └── bootstrap-to-be.jpg │ │ ├── system-management │ │ │ └── .gitignore │ │ ├── template.md │ │ └── testqa │ │ │ └── .gitignore │ ├── legacy-design │ │ ├── .gitignore │ │ ├── README.md │ │ ├── Registry-Abstraction.pdf │ │ └── device-service │ │ │ └── discovery.md │ ├── legacy-requirements │ │ ├── .gitignore │ │ ├── README.md │ │ └── device-service.md │ └── ucr │ │ ├── Bring-Your-Own-Vault.md │ │ ├── Common Configuration.md │ │ ├── Core-Data-Retention.md │ │ ├── Device-Parent-Child-Relationships.md │ │ ├── Extending-Device-Data.md │ │ ├── Microservice-Authentication.md │ │ ├── Performance-Test-Harness.md │ │ ├── Provision-Watch-via-Device-Metadata.md │ │ ├── README.md │ │ ├── Record-and-Replay.md │ │ ├── System-Events-for-Devices.md │ │ ├── URIs-for-Files.md │ │ ├── performance-test.png │ │ └── template.md ├── docker.png ├── examples │ ├── AppServiceExamples.md │ ├── Ch-CommandingDeviceThroughRulesEngine.md │ ├── Ch-ExamplesAddingSNMPDevice.md │ ├── Ch-ExamplesSendingAndConsumingBinary.md │ ├── Ch-ExamplesVirtualDeviceService.md │ ├── EdgeX_ExamplesDatanabSensor.JPG │ ├── EdgeX_ExamplesMQTTApplicationProperties.png │ ├── EdgeX_ExamplesMQTTBrokerAddress.png │ ├── EdgeX_ExamplesMQTTCommandTopic.png │ ├── EdgeX_ExamplesMQTTDeviceCommands.png │ ├── EdgeX_ExamplesMQTTDeviceService.png │ ├── EdgeX_ExamplesMQTTProject.png │ ├── EdgeX_ExamplesMQTTRequestsToCoreData.png │ ├── EdgeX_ExamplesMQTTTestSender.png │ ├── EdgeX_ExamplesMQTTUiConsole.png │ ├── EdgeX_ExamplesMQTTWebsocketUi.png │ ├── EdgeX_ExamplesNI9038.jpg │ ├── EdgeX_Examples_Patlite.jpg │ ├── EdgeX_Patlite_Green_On.jpg │ ├── IncomingResponse.png │ ├── MQTTBroker.png │ ├── MQTTdiagram.png │ ├── VirtualSequence.png │ ├── Virtual_DS.png │ ├── app-service-examples │ │ └── camera-management │ │ │ └── images │ │ │ ├── api-log.png │ │ │ ├── bad-response.png │ │ │ ├── camera-position.png │ │ │ ├── camera.png │ │ │ ├── example-analytics.png │ │ │ ├── good-response.png │ │ │ ├── homepage-demo-app-1.png │ │ │ ├── inference-edgex.png │ │ │ ├── inference-events-default.png │ │ │ ├── inference-events.png │ │ │ ├── multiple-pipelines-default.png │ │ │ ├── running-pipelines.png │ │ │ ├── select-camera.png │ │ │ ├── select-pipeline.png │ │ │ ├── select-profile.png │ │ │ └── stop-pipeline.png │ ├── getcommand_MQTT.png │ ├── getreading_MQTT.png │ ├── index.md │ ├── modbus.test.device.profile.yml │ ├── mqtt.test.device.profile.yml │ ├── patlite-snmp.yml │ ├── putModbusPal.png │ ├── putbody.png │ ├── putcommand_MQTT.png │ └── scheduleconfig_MQTT.png ├── general │ ├── CN-EN.png │ ├── CNCF-logo.png │ ├── ContainerNames.md │ ├── Definitions.md │ ├── EdgeX_ApplicationServicesLayer.png │ ├── EdgeX_CN.md │ ├── EdgeX_CoreServicesHighlighted.png │ ├── EdgeX_CoreServicesLayer.png │ ├── EdgeX_DeviceServicesLayer.png │ ├── EdgeX_RegistryHighlighted.png │ ├── EdgeX_Security.png │ ├── EdgeX_SecurityLayer.png │ ├── EdgeX_SupportingServicesLayer.png │ ├── EdgeX_X.png │ ├── EdgeX_architecture.png │ ├── EdgeX_data-flow.png │ ├── EdgeX_deployments.png │ ├── EdgeX_gateway.png │ ├── EdgeX_logo.png │ ├── EdgeX_microservice_arch.png │ ├── EdgeX_middleware.png │ ├── EdgeX_octopus.png │ ├── EdgeX_step1-1.png │ ├── EdgeX_step1-2.png │ ├── EdgeX_step2.png │ ├── EdgeX_step3.png │ ├── EdgeX_step4.png │ ├── EdgeX_step5.png │ ├── EdgeX_step6.png │ ├── EdgeX_step7.png │ ├── PlatformRequirements.md │ ├── ServiceConfiguration.md │ ├── ServicePorts.md │ └── conf.py ├── getting-started │ ├── Ch-GettingStartedCDevelopers.md │ ├── Ch-GettingStartedDTOValidation.md │ ├── Ch-GettingStartedDevelopers.md │ ├── Ch-GettingStartedDockerUsers.md │ ├── Ch-GettingStartedGoDevelopers.md │ ├── Ch-GettingStartedHybrid.md │ ├── Ch-GettingStartedUsers.md │ ├── Ch-GettingStartedUsersNexus.md │ ├── EdgeX-GettingStartedSnapUsersUI.png │ ├── EdgeX_DeviceServiceSDK.png │ ├── EdgeX_GettingStartedBranchSelection.png │ ├── EdgeX_GettingStartedBuild.png │ ├── EdgeX_GettingStartedChangeToNexus.png │ ├── EdgeX_GettingStartedClone.png │ ├── EdgeX_GettingStartedHybridBuild.png │ ├── EdgeX_GettingStartedHybridDeviceVirtualLog.png │ ├── EdgeX_GettingStartedHybridResults.png │ ├── EdgeX_GettingStartedHybridRun.png │ ├── EdgeX_GettingStartedHybridRunContainers.png │ ├── EdgeX_GettingStartedNexusCompose.png │ ├── EdgeX_GettingStartedNexusComposeNew.png │ ├── EdgeX_GettingStartedRunMetadata.png │ ├── EdgeX_GettingStartedUsrActiveContainers.png │ ├── EdgeX_GettingStartedUsrLogs.png │ ├── EdgeX_GettingStartedUsrPing.png │ ├── EdgeX_GoLandMakeBuild.png │ ├── EdgeX_GoLandMakeRun.png │ ├── EdgeX_GoLandOpenProject.png │ ├── EdgeX_GoLandSelectProject.png │ ├── EdgeX_GoLandViewTerminal.png │ ├── gcc-logo.png │ ├── golang-vector-6.png │ ├── index.md │ ├── native │ │ ├── BuildAppServiceConf-Windows.png │ │ ├── BuildAppServiceConf.png │ │ ├── BuildDeviceVirtual-Windows.png │ │ ├── BuildDeviceVirtual.png │ │ ├── BuildEdgeXGoServices-Windows.png │ │ ├── BuildEdgeXGoServices.png │ │ ├── BuildEssentialCheck.png │ │ ├── BuildGUI-Windows.png │ │ ├── BuildGUI.png │ │ ├── BuildeKuiper.png │ │ ├── Ch-BuildRunNative.md │ │ ├── Ch-BuildRunOnArm32.md │ │ ├── Ch-BuildRunOnLinuxDistro.md │ │ ├── Ch-BuildRunOnWindows.md │ │ ├── CheckeKuiperRunning-OK.png │ │ ├── CheckeKuiperRunning-Oops.png │ │ ├── CreateeKuiperRule.png │ │ ├── CreateeKuiperStream.png │ │ ├── DataCenterDisplayData.png │ │ ├── GitCheck-Windows.png │ │ ├── GitCheck.png │ │ ├── GoLangCheck-Windows.png │ │ ├── GoLangCheck.png │ │ ├── LocationConfigAppService.png │ │ ├── LocationDeviceVirtualService.png │ │ ├── LocationEdgeXGUI.png │ │ ├── LocationeKuiper-arm.png │ │ ├── LocationeKuiper.png │ │ ├── LocationeKuiperStreamLog-arm.png │ │ ├── LocationeKuiperStreamLog.png │ │ ├── NohupTailFile.png │ │ ├── RunGUI.png │ │ ├── StreamOfEventReadings.png │ │ ├── TaileKuiperLog-arm.png │ │ ├── TaileKuiperLog.png │ │ ├── WindowsEnvVar.png │ │ ├── WindowsNewSystemVar.png │ │ └── WindowsSystemProperties.png │ ├── quick-start │ │ ├── EdgeX_ConnectToHiveMQ.png │ │ ├── EdgeX_GettingStartedCommandGet.png │ │ ├── EdgeX_GettingStartedCommandGetAfterPut.png │ │ ├── EdgeX_GettingStartedCommandPut.png │ │ ├── EdgeX_GettingStartedRandomIntegerData.png │ │ ├── EdgeX_GettingStartedUsrActiveContainers.png │ │ ├── EdgeX_HiveMQTTMessages.png │ │ ├── EdgeX_HiveMQTTWebClient.png │ │ └── index.md │ └── tools │ │ ├── Ch-GUI.md │ │ ├── EdgeX_AddDeviceWizard.png │ │ ├── EdgeX_AddeKuiperRule.png │ │ ├── EdgeX_AppServiceConfButton.png │ │ ├── EdgeX_AppServiceList.png │ │ ├── EdgeX_AssocProfileServiceLinks.png │ │ ├── EdgeX_AssociatedDeviceIcon.png │ │ ├── EdgeX_AssociatedDevicesButton.png │ │ ├── EdgeX_CantRemoveProfile.png │ │ ├── EdgeX_CommandExecute.png │ │ ├── EdgeX_Compose_With_app_sample.png │ │ ├── EdgeX_DSSettings.png │ │ ├── EdgeX_Dashboard.png │ │ ├── EdgeX_Dashboard2.png │ │ ├── EdgeX_Dashboard_Error.png │ │ ├── EdgeX_DeviceList.png │ │ ├── EdgeX_DeviceProfileList.png │ │ ├── EdgeX_EditAutoEvents.png │ │ ├── EdgeX_EventStream.png │ │ ├── EdgeX_GUI_Login.jpg │ │ ├── EdgeX_GUI_Mobile.jpg │ │ ├── EdgeX_Hamburger_Icon.png │ │ ├── EdgeX_Interval.png │ │ ├── EdgeX_IntervalAction.png │ │ ├── EdgeX_Menu_Icons.png │ │ ├── EdgeX_Metadata.png │ │ ├── EdgeX_Notifications.png │ │ ├── EdgeX_OperationButtons.png │ │ ├── EdgeX_ProvisionWatcherList.png │ │ ├── EdgeX_RuleNoStream.png │ │ ├── EdgeX_Scheduler.png │ │ ├── EdgeX_Service_Metrics.png │ │ ├── EdgeX_StoppedService.png │ │ ├── EdgeX_Subscriptions.png │ │ ├── EdgeX_TokenPrompt.png │ │ ├── EdgeX_eKuiperStream.png │ │ └── update-device.png ├── hybrid.png ├── index.md ├── microservices │ ├── application │ │ ├── ApiReference.md │ │ ├── ApplicationServices.md │ │ ├── ApplicationServices.png │ │ ├── Configuration.md │ │ ├── GettingStarted.md │ │ ├── SDKFunctions.png │ │ ├── TriggersFunctions.png │ │ ├── V3Migration.md │ │ ├── details │ │ │ ├── CommandLine.md │ │ │ ├── EnvironmentVariables.md │ │ │ ├── SeedingSecrets.md │ │ │ ├── ServiceMetrics.md │ │ │ └── Triggers.md │ │ ├── sdk-python │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ ├── api │ │ │ │ ├── AppFunctionContextAPI.md │ │ │ │ ├── ApplicationServiceAPI.md │ │ │ │ └── BuiltInPipelineFunctions.md │ │ │ └── details │ │ │ │ ├── CustomConfiguration.md │ │ │ │ ├── CustomRestApis.md │ │ │ │ ├── CustomServiceMetrics.md │ │ │ │ ├── ErrorHandling.md │ │ │ │ ├── PipelinesPerTopics.md │ │ │ │ ├── PublishingMessageBus.md │ │ │ │ ├── Secrets.md │ │ │ │ ├── StoreAndForward.md │ │ │ │ └── TargetType.md │ │ ├── sdk │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ ├── api │ │ │ │ ├── AppFunctionContextAPI.md │ │ │ │ ├── ApplicationServiceAPI.md │ │ │ │ └── BuiltInPipelineFunctions.md │ │ │ └── details │ │ │ │ ├── BackgroundPublishing.md │ │ │ │ ├── CustomConfiguration.md │ │ │ │ ├── CustomRestApis.md │ │ │ │ ├── CustomServiceMetrics.md │ │ │ │ ├── ErrorHandling.md │ │ │ │ ├── PipelinesPerTopics.md │ │ │ │ ├── Secrets.md │ │ │ │ ├── StoreAndForward.md │ │ │ │ └── TargetType.md │ │ └── services │ │ │ ├── AppLLRPInventory.md │ │ │ ├── AppLLRPInventory │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── details │ │ │ │ ├── Behaviors.md │ │ │ │ ├── InventoryEvents.md │ │ │ │ ├── LocationAliases.md │ │ │ │ ├── MobilityProfile.md │ │ │ │ ├── TagLocationAlgorithm.md │ │ │ │ ├── aliases.png │ │ │ │ ├── consul_alias_folder.png │ │ │ │ ├── consul_kv_pairs.png │ │ │ │ ├── mobility-profile.png │ │ │ │ └── tag-state-diagram.png │ │ │ ├── AppRecordReplay │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ └── SourceCode.md │ │ │ └── AppServiceConfigurable │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── details │ │ │ ├── AvailablePipelineFunctions.md │ │ │ ├── PipelinePerTopics.md │ │ │ ├── Profiles.md │ │ │ └── TargetType.md │ ├── configuration │ │ ├── CommonCommandLineOptions.md │ │ ├── CommonConfiguration.md │ │ ├── CommonEnvironmentVariables.md │ │ ├── ConfigurationAndRegistry.md │ │ ├── EdgeX_ConfigurationRegistry.png │ │ ├── EdgeX_CoreRegConfig.png │ │ ├── EdgeX_RegistryHighlighted.png │ │ └── V3MigrationCommonConfig.md │ ├── core │ │ ├── .gitignore │ │ ├── Ch-CoreServices.md │ │ ├── EdgeX_CoreServices.png │ │ ├── command │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── EdgeX_Command.png │ │ │ ├── EdgeX_CommandPutRequest.png │ │ │ ├── EdgeX_CommandRequestForDevices.png │ │ │ ├── EdgeX_CoreCommandModel.png │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── details │ │ │ │ └── RegexGetCommand.md │ │ ├── data │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── EdgeX_CoreData.png │ │ │ ├── EdgeX_CoreDataRESTEndpoint.png │ │ │ ├── EdgeX_CoreDataSubscriber.png │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── details │ │ │ │ ├── DataRetention.md │ │ │ │ ├── EdgeX_Event-Reading.png │ │ │ │ └── EventsAndReadings.md │ │ └── metadata │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── EdgeX_DS_Access.png │ │ │ ├── EdgeX_Metadata.png │ │ │ ├── EdgeX_Metadata2.png │ │ │ ├── EdgeX_Metadata3.png │ │ │ ├── EdgeX_MetadataAddDeviceProfileStep1.png │ │ │ ├── EdgeX_MetadataAddDeviceProfileStep2.png │ │ │ ├── EdgeX_MetadataDeviceStartup.png │ │ │ ├── EdgeX_MetadataModel.png │ │ │ ├── EdgeX_MetadataModel_Commands.png │ │ │ ├── EdgeX_MetadataModel_Profile.png │ │ │ ├── EdgeX_MetadataModel_ProvisionWatcher.png │ │ │ ├── GettingStarted.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── details │ │ │ ├── DeviceProfile.md │ │ │ └── DeviceSystemEvents.md │ ├── device │ │ ├── ApiReference.md │ │ ├── Configuration.md │ │ ├── DeviceService.md │ │ ├── EdgeX_Device.png │ │ ├── EdgeX_DeviceServiceAbstraction.png │ │ ├── EdgeX_DeviceServices.png │ │ ├── GettingStarted.md │ │ ├── V3Migration.md │ │ ├── details │ │ │ ├── AutoEvents.md │ │ │ ├── Auto_Events.png │ │ │ ├── CommandLine.md │ │ │ ├── Device.png │ │ │ ├── DeviceCommands.md │ │ │ ├── DeviceDefinitions.md │ │ │ ├── DeviceDiscovery.md │ │ │ ├── DeviceProfiles.md │ │ │ ├── Device_Command.png │ │ │ ├── EnvironmentVariables.md │ │ │ ├── SeedingSecrets.md │ │ │ └── ServiceMetrics.md │ │ ├── how-to │ │ │ ├── Ch-RemoteNonSecure.md │ │ │ └── Ch-RemoteSecure.md │ │ ├── sdk │ │ │ ├── DeviceSystemEvents.md │ │ │ ├── EdgeX_SDKs.png │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ ├── api │ │ │ │ ├── CDeviceSDK │ │ │ │ │ ├── CDeviceSDKAPI.md │ │ │ │ │ └── CUtilities.md │ │ │ │ └── GoDeviceSDK │ │ │ │ │ ├── GoDeviceSDKAPI.md │ │ │ │ │ └── GoProtocolDriverAPI.md │ │ │ ├── details │ │ │ │ ├── CustomConfiguration.md │ │ │ │ ├── CustomRestApis.md │ │ │ │ ├── CustomServiceMetrics.md │ │ │ │ ├── DeviceCommands.md │ │ │ │ └── Secrets.md │ │ │ └── devicesdk-getting-started │ │ │ │ ├── EdgeX_GettingStartedGoModInit.png │ │ │ │ ├── EdgeX_GettingStartedLocateDriver.png │ │ │ │ ├── EdgeX_GettingStartedSDKBuild.png │ │ │ │ ├── EdgeX_GettingStartedSDKClone.png │ │ │ │ ├── EdgeX_GettingStartedSDKCompileC.png │ │ │ │ ├── EdgeX_GettingStartedSDKCopyFiles.png │ │ │ │ ├── EdgeX_GettingStartedSDKCopyFilesC.png │ │ │ │ ├── EdgeX_GettingStartedSDKGoAddImports.png │ │ │ │ ├── EdgeX_GettingStartedSDKGoGenNumber.png │ │ │ │ ├── EdgeX_GettingStartedSDKGoMod.png │ │ │ │ ├── EdgeX_GettingStartedSDKReplaceImports.png │ │ │ │ ├── EdgeX_SampleDeviceProfile_DeviceResources.png │ │ │ │ ├── EdgeX_SampleDeviceProfile_DeviceResourcesC.png │ │ │ │ ├── GettingStartedSDK-C.md │ │ │ │ ├── GettingStartedSDK-Go.md │ │ │ │ ├── configuration.yaml │ │ │ │ ├── random-generator-devices.json │ │ │ │ ├── random-generator-devices.yaml │ │ │ │ └── random-generator.yaml │ │ └── services │ │ │ ├── device-bacnet.md │ │ │ ├── device-coap.md │ │ │ ├── device-gpio │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── GettingStarted.md │ │ │ ├── ProtocolProperties.md │ │ │ ├── Purpose.md │ │ │ └── SourceCode.md │ │ │ ├── device-modbus │ │ │ ├── APIReference.md │ │ │ ├── Configuration.md │ │ │ ├── EdgeX_ExampleModbus_simulator_addmockdevice.png │ │ │ ├── EdgeX_ExampleModbus_simulator_addregister.png │ │ │ ├── EdgeX_ExampleModbus_simulator_addvaluegen.png │ │ │ ├── EdgeX_ExampleModbus_simulator_bindvaluegen.png │ │ │ ├── EdgeX_ExampleModbus_simulator_run.png │ │ │ ├── GettingStarted.md │ │ │ ├── ProtocolProperties.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── details │ │ │ │ ├── DataTypeConversion.md │ │ │ │ ├── ModbusReadConversion.png │ │ │ │ └── ModbusWriteConversion.png │ │ │ ├── device-mqtt.md │ │ │ ├── device-mqtt │ │ │ ├── APIReference.md │ │ │ ├── Ch-ExamplesAddingMQTTDevice.md │ │ │ ├── Configuration.md │ │ │ ├── EdgeX_ExamplesMQTTDeviceSimulator.png │ │ │ ├── GettingStarted.md │ │ │ ├── MQTT_Example_Overview.png │ │ │ ├── ProtocolProperties.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── details │ │ │ │ └── MultiLevelTopics.md │ │ │ ├── device-onvif-camera │ │ │ ├── General.md │ │ │ ├── Walkthrough │ │ │ │ ├── custom-build.md │ │ │ │ ├── deployment.md │ │ │ │ ├── general-usage.md │ │ │ │ └── setup.md │ │ │ ├── assets │ │ │ │ └── onvif-mermaid.md │ │ │ ├── images │ │ │ │ ├── EdgeXDashboard.png │ │ │ │ ├── EdgeXDeviceList.png │ │ │ │ ├── EdgeXDeviceProfiles.png │ │ │ │ ├── EdgeXDeviceServices.png │ │ │ │ ├── EdgeXJWTLogin.png │ │ │ │ ├── ONVIFDeviceServiceArch.png │ │ │ │ ├── add-device-sequence.png │ │ │ │ ├── api-analytic-support-add-rule.png │ │ │ │ ├── api-analytic-support-example.jpg │ │ │ │ ├── api-analytic-support-query-analytics-module-options-1.jpg │ │ │ │ ├── api-analytic-support-query-analytics-module-options-2.jpg │ │ │ │ ├── api-analytic-support-query-analytics-module.jpg │ │ │ │ ├── api-analytic-support-query-rules.jpg │ │ │ │ ├── auto-discovery-docker-overview.jpg │ │ │ │ ├── auto-discovery-flowchart.png │ │ │ │ ├── auto-discovery.jpg │ │ │ │ ├── connect-existing-device.png │ │ │ │ ├── credential-lookup-during-discovery.png │ │ │ │ ├── creds-acl.png │ │ │ │ ├── creds-edit-method.png │ │ │ │ ├── creds-edit-password.png │ │ │ │ ├── creds-edit-user.png │ │ │ │ ├── creds-mac-multiple.png │ │ │ │ ├── creds-mac.png │ │ │ │ ├── creds-method.png │ │ │ │ ├── creds-name.png │ │ │ │ ├── creds-password.png │ │ │ │ ├── creds-pick-existing.png │ │ │ │ ├── creds-pick.png │ │ │ │ ├── creds-username.png │ │ │ │ ├── getting-started-with-docker-consul-keyvalue.jpg │ │ │ │ ├── getting-started-with-docker-consul.jpg │ │ │ │ ├── onvif-user-authentication-flow.jpg │ │ │ │ ├── onvif-user-authentication-usernametoken.jpg │ │ │ │ ├── onvif-user-authentication.jpg │ │ │ │ └── status-flowchart.png │ │ │ ├── supplementary-info │ │ │ │ ├── ONVIF-protocol.md │ │ │ │ ├── api-analytic-support.md │ │ │ │ ├── api-event-handling.md │ │ │ │ ├── api-usage-user-handling.md │ │ │ │ ├── auto-discovery.md │ │ │ │ ├── control-plane-events.md │ │ │ │ ├── credentials.md │ │ │ │ ├── custom-metadata-feature.md │ │ │ │ ├── device-status.md │ │ │ │ ├── friendlyname-mac.md │ │ │ │ ├── getting-started-with-docker-security.md │ │ │ │ ├── onvif-footnotes.md │ │ │ │ ├── onvif-user-authentication.md │ │ │ │ ├── reboot-needed.md │ │ │ │ ├── test-with-postman.md │ │ │ │ ├── utility-scripts.md │ │ │ │ └── ws-discovery.md │ │ │ └── swagger.md │ │ │ ├── device-opc-ua │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── EdgeX_ExampleOPCUA_simulation_objects.png │ │ │ ├── EdgeX_ExampleOPCUA_simulation_startup.png │ │ │ ├── EdgeX_ExampleOPCUA_simulation_status.png │ │ │ ├── GettingStarted.md │ │ │ ├── ProtocolProperties.md │ │ │ ├── Purpose.md │ │ │ └── SourceCode.md │ │ │ ├── device-rest │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── GettingStarted.md │ │ │ ├── ProtocolProperties.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ └── howto │ │ │ │ └── Testing.md │ │ │ ├── device-rfid-llrp.md │ │ │ ├── device-s7 │ │ │ ├── ApiReference.md │ │ │ ├── Configuration.md │ │ │ ├── GettingStarted.md │ │ │ ├── ProtocolProperties.md │ │ │ ├── Purpose.md │ │ │ ├── SourceCode.md │ │ │ ├── details │ │ │ │ ├── DataTypeConversion.md │ │ │ │ ├── s7_data_type_conersion_read.png │ │ │ │ └── s7_data_type_conersion_write.png │ │ │ ├── s7_communication_limitation.jpg │ │ │ ├── s7_data_block_1.jpg │ │ │ ├── s7_data_block_4.jpg │ │ │ ├── s7_enable_s7_communication.jpg │ │ │ └── s7_ip_address.jpg │ │ │ ├── device-snmp.md │ │ │ ├── device-uart │ │ │ ├── APIReference.md │ │ │ ├── Configuration.md │ │ │ ├── GettingStarted.md │ │ │ ├── ProtocolProperties.md │ │ │ ├── Purpose.md │ │ │ └── SourceCode.md │ │ │ ├── device-usb-camera │ │ │ ├── General.md │ │ │ ├── images │ │ │ │ └── USBDeviceServiceArch.png │ │ │ ├── supplementary-info │ │ │ │ ├── USB-protocol.md │ │ │ │ ├── advanced-options.md │ │ │ │ └── discovery.md │ │ │ └── walkthrough │ │ │ │ ├── custom-build.md │ │ │ │ ├── deployment.md │ │ │ │ ├── general-usage.md │ │ │ │ └── setup.md │ │ │ └── device-virtual │ │ │ ├── Ch-VirtualDevice.md │ │ │ └── EdgeX_VirtualDevice.png │ ├── general │ │ ├── MultipleInstances.png │ │ ├── database │ │ │ └── Ch-Postgres.md │ │ ├── index.md │ │ ├── messagebus diagram.drawio │ │ ├── messagebus diagram.jpg │ │ └── messagebus.md │ └── support │ │ ├── Ch-SupportingServices.md │ │ ├── EdgeX_SupportingServices.png │ │ ├── eKuiper │ │ ├── Ch-eKuiper.md │ │ ├── EdgeX_eKuiperRulesEngine.png │ │ ├── arch.png │ │ └── arch_light.png │ │ ├── notifications │ │ ├── ApiReference.md │ │ ├── Configuration.md │ │ ├── EdgeX_SupportingServicesAlertsArchitecture.png │ │ ├── EdgeX_SupportingServicesAlertsArchitecture.xml │ │ ├── EdgeX_SupportingServicesAlertsNotifications.png │ │ ├── EdgeX_SupportingServicesNotificationsModel.png │ │ ├── EdgeX_SupportingServicesNotificationsModel.xml │ │ ├── GettingStarted.md │ │ ├── HowTo_EmailNotifications.md │ │ ├── Purpose.md │ │ ├── SourceCode.md │ │ └── details │ │ │ └── DataRetention.md │ │ └── scheduler │ │ ├── ApiReference.md │ │ ├── Configuration.md │ │ ├── EdgeX_SupportingServicesScheduling.png │ │ ├── GettingStarted.md │ │ ├── Purpose.md │ │ ├── SourceCode.md │ │ └── details │ │ └── DataRetention.md ├── run.png ├── security │ ├── .gitignore │ ├── Ch-APIGateway.md │ ├── Ch-Authenticating.md │ ├── Ch-CORS-Settings.md │ ├── Ch-Configuring-Add-On-Services.md │ ├── Ch-DelayedStartServices.md │ ├── Ch-RemoteDeviceServices.md │ ├── Ch-SecretProviderApi.md │ ├── Ch-SecretStore.md │ ├── Ch-SecretStoreSetup.md │ ├── Ch-Secure-Consul.md │ ├── Ch-Secure-MessageBus.md │ ├── Ch-Secure-Postgres.md │ ├── Ch-Security.md │ ├── Ch-SecurityIssues.md │ ├── EdgeX_Security.png │ ├── Rootless-Docker.md │ ├── SeedingServiceSecrets.md │ ├── V3Migration.md │ ├── authentication-network.jpg │ ├── consul-login-input.png │ ├── consul-login.png │ ├── secrets-config-proxy.md │ ├── secrets-config.md │ └── security-file-token-provider.1.md ├── sensor.png ├── snap.png ├── threat-models │ ├── secret-store │ │ ├── README.md │ │ ├── arch-as-is.jpg │ │ ├── arch-in-context.jpg │ │ ├── arch-proposed.jpg │ │ ├── background.md │ │ ├── general_requirements.jpg │ │ ├── high_level_architecture.jpg │ │ ├── high_level_design.md │ │ ├── pki_initialization.jpg │ │ ├── threat_model.md │ │ ├── token_handshake.jpg │ │ ├── vault_initialization.jpg │ │ └── vault_master_key_encryption.md │ └── stride-model │ │ ├── EdgeX Foundry Threat Modelv2.2.tm7 │ │ ├── EdgeX-STRIDE.md │ │ ├── EdgeXFoundryThreatReportV2.2-original.md │ │ ├── EdgeXFoundryThreatReportV2.2.htm │ │ ├── EdgeXFoundryThreatReportV2.2.md │ │ ├── IoTDefault.tb7 │ │ └── images │ │ ├── 000754c9748372ccedffc49501de21ef3f190834.png │ │ ├── 1dd5023016ec714c4a35acbca5f864d470066513.png │ │ ├── 1f292f1a3d48be04ffe8699cdd4fce3d5ce26378.png │ │ ├── 27aff3dc2f3be34f14c9df98144e45253ab5a3f2.png │ │ ├── 370d40538ed437868c549d375c80fc346bb74d78.png │ │ ├── 37e3359d25fa97249ccb455d02d007c38c2c5ee6.png │ │ ├── 452c630b73ccf9644f721b0e1996d525ca23e7c3.png │ │ ├── 51fd5bb8dbafb70a81ea944df00bafd09f572145.png │ │ ├── 58a5dfd01d7bfd7e696b1eb90413109b63015f24.png │ │ ├── 5b6b1393903b5dbab7dc230af2a390c29ecc10de.png │ │ ├── 5be215f86d45911102a7f04833341d1daeefa06a.png │ │ ├── 7b330b153ded5645477e4aab00a47fc72df84540.png │ │ ├── 83291d39671446a08d933ebb79fe3dfc6c83397f.png │ │ ├── 93d4c0008d705bc3a754f06ab674dfd81f209cb8.png │ │ ├── 982310eb4e8fc122b54a0d765674cd5eab0ac7e1.png │ │ ├── 9903754dc4447477796031724a9061ae28da9774.png │ │ ├── 9ab35f47ac55cc1aaf2ad660f5b1460490d8c6d3.png │ │ ├── 9cb564f532d6ff91c53ea79ecf1ad9ed5faf8700.png │ │ ├── 9fec79313ae64a7598250237fcd77f4313fb9050.png │ │ ├── a4fd191dbdf6414eba87d73172e82ae4c2aa1ca0.png │ │ ├── aa69f547ac6a70d383c2ebd8e25a46a5ecdc92d4.png │ │ ├── aac9c8f8a15a73056a1aeb22f018c9f4adfeb82c.png │ │ ├── c7507325cde7578f40b525bd350167e26dbc156d.png │ │ ├── d234fbeac22fb73adf69619f8ad2021fc366eee4.png │ │ ├── d3995a698c2088f95d0c475b00f6be8d7e5fa92f.png │ │ ├── d5a51b38fede063079dfcd0b09d519f82b5fc397.png │ │ ├── d5c5f624f27b635fb01afcba1ccf2cf6a0054468.png │ │ ├── d5f2a45878bc7b3c416a69b2241f085e2d683149.png │ │ ├── d840bf18c36361a6cf0c76f061343f008b58aca0.png │ │ ├── ddca459de99927ac2cade07d1bf2643b16073bdf.png │ │ └── ffee1c08d6afa3f01c1780fbd66ee34aa1e1223c.png └── walk-through │ ├── Ch-Walkthrough.md │ ├── Ch-WalkthroughCommands.md │ ├── Ch-WalkthroughDeviceProfile.md │ ├── Ch-WalkthroughExporting.md │ ├── Ch-WalkthroughProvision.md │ ├── Ch-WalkthroughReading.md │ ├── Ch-WalkthroughSetup.md │ ├── Ch-WalkthroughUseCase.md │ ├── EdgeX_CameraMonitorProfile.yml │ ├── EdgeX_WalkthroughAppServiceLog.png │ ├── EdgeX_WalkthroughCameraCommands.png │ ├── EdgeX_WalkthroughConsulKeyValue.png │ ├── EdgeX_WalkthroughConsulSetLogLevel.png │ ├── EdgeX_WalkthroughCurlPOST_Response.png │ ├── EdgeX_WalkthroughDeployment.png │ ├── EdgeX_WalkthroughGetCommands.png │ ├── EdgeX_WalkthroughGetCommands_Curl.png │ ├── EdgeX_WalkthroughHumansCanine.png │ ├── EdgeX_WalkthroughPostValueDescriptor.png │ ├── EdgeX_WalkthroughPostmanFile.png │ ├── EdgeX_WalkthroughPostmanHeaders.png │ ├── EdgeX_WalkthroughPostmanPOST.png │ ├── EdgeX_WalkthroughPostmanPOST_Response.png │ ├── EdgeX_WalkthroughPutCommandURL.png │ ├── EdgeX_WalkthroughSendEvent.png │ ├── EdgeX_WalkthroughSendEvent_Curl.png │ └── EdgeX_WalkthroughSnapshotDepth.png ├── mkdocs.yml └── template_macros.yaml /.blubracket/ignore.yaml: -------------------------------------------------------------------------------- 1 | - paths: 2 | - "**/search_index.json" 3 | - "**/index.html" 4 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | **If your build fails** due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-docs/blob/main/.github/Contributing.md 8 | 9 | ## PR Checklist 10 | Please check if your PR fulfills the following requirements: 11 | 12 | - [ ] Changes have been rendered and validated locally using mkdocs-material (see edgex-docs README) 13 | -------------------------------------------------------------------------------- /.github/semantic.yml: -------------------------------------------------------------------------------- 1 | allowMergeCommits: true 2 | # Always validate the PR title AND all the commits 3 | titleAndCommits: true 4 | types: 5 | - feat 6 | - fix 7 | - style 8 | - build 9 | - ci 10 | - revert 11 | scopes: 12 | - api 13 | - adr 14 | - ucr 15 | - legacy 16 | - examples 17 | - microservices 18 | - security 19 | - ref 20 | - walkthru 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Intellij 2 | .idea/ 3 | *.iml 4 | *.iws 5 | 6 | .project 7 | .vscode/ 8 | coverage.out 9 | 10 | # compile HTML 11 | docs/_build/ 12 | docs.log 13 | docs/*/ 14 | 15 | # log dirs 16 | **/logs 17 | 18 | -------------------------------------------------------------------------------- /Dockerfile.docs: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (c) 2022-2023 Intel Corporation 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | 16 | # Useful for local testing 17 | 18 | FROM python:3.13-slim 19 | 20 | RUN pip install mkdocs \ 21 | "mkdocs-material==9.1.19" \ 22 | "mkdocs-htmlproofer-plugin>=0.8" \ 23 | "mkdocs-macros-plugin>=0.5" \ 24 | "mkdocs-swagger-ui-tag" 25 | 26 | EXPOSE 8000 27 | 28 | ENTRYPOINT ["mkdocs"] 29 | CMD ["serve", "--dev-addr=0.0.0.0:8008"] 30 | -------------------------------------------------------------------------------- /GOVERNANCE.md: -------------------------------------------------------------------------------- 1 | # Governance 2 | 3 | Project governance as well as policies, procedures and instructions for contributing to EdgeX Foundry can be found on our Wiki site at the following locations: 4 | 5 | - [EdgeX Technical Steering Committee](https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=329436) 6 | - [Contributor's Guide](https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Guide) 7 | - [Contributor's Process](https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Process) 8 | - [Technical Work](https://wiki.edgexfoundry.org/display/FA/Technical+Work+in+the+EdgeX+Foundry+Project) 9 | - [Contributors, Committers & Maintainers](https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=21823860) -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: serve 2 | 3 | MKDOCS_IMAGE ?= edgex-mkdocs 4 | 5 | clean: 6 | rm -rf docs/*/ 7 | docker rmi -f $(MKDOCS_IMAGE) 8 | 9 | build-docker: 10 | docker build \ 11 | -f Dockerfile.docs \ 12 | -t $(MKDOCS_IMAGE) \ 13 | . 14 | 15 | build: build-docs 16 | 17 | # Can be used to verify that mkdocs build works properly 18 | build-docs: build-docker 19 | docker run --rm \ 20 | -v $(PWD):/docs \ 21 | -w /docs \ 22 | -e ENABLED_HTMLPROOFER \ 23 | $(MKDOCS_IMAGE) \ 24 | build 25 | 26 | # Most common use case, serve docs on :8008 27 | serve: build-docker serve-docs 28 | 29 | serve-docs: 30 | docker run --rm \ 31 | -it \ 32 | -p 8008:8008 \ 33 | -v $(PWD):/docs \ 34 | -w /docs \ 35 | -e ENABLED_HTMLPROOFER \ 36 | $(MKDOCS_IMAGE) -------------------------------------------------------------------------------- /OWNERS.md: -------------------------------------------------------------------------------- 1 | # Repository Owners 2 | 3 | This repository is managed by the EdgeX Core Working Group. As such, the **Core Working Group** chairman is considered the "owner" of the repository and approves all committers of the repository. 4 | 5 | See the [project Wiki TSC page](https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=329436#TechnicalSteeringCommittee(TSC)-WorkingGroups) for information on the current EdgeX TSC and who occupies the role of Core Working Group chair. 6 | 7 | For a complete list of current committers see: https://github.com/orgs/edgexfoundry/teams/edgex-go-committers/members. 8 | 9 | -------------------------------------------------------------------------------- /docs/CNAME: -------------------------------------------------------------------------------- 1 | docs.edgexfoundry.org -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Redirecting to latest... 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/robots.txt: -------------------------------------------------------------------------------- 1 | # used to keep google and other search engines looking at the latest version of the docs and not an older version 2 | User-agent: * 3 | Allow: /2.3/ 4 | Sitemap: https://docs.edgexfoundry.org/3.0/sitemap.xml 5 | Sitemap: https://docs.edgexfoundry.org/2.3/sitemap.xml 6 | Sitemap: https://docs.edgexfoundry.org/2.2/sitemap.xml 7 | Sitemap: https://docs.edgexfoundry.org/2.1/sitemap.xml 8 | Sitemap: https://docs.edgexfoundry.org/2.0/sitemap.xml 9 | Sitemap: https://docs.edgexfoundry.org/1.3/sitemap.xml 10 | Sitemap: https://docs.edgexfoundry.org/1.2/sitemap.xml 11 | -------------------------------------------------------------------------------- /docs/versions.json: -------------------------------------------------------------------------------- 1 | [ 2 | { "version": "4.1", "title": "4.1-Palau (WIP)", "aliases": [] }, 3 | { "version": "4.0", "title": "4.0-Odesa", "aliases": [ "latest" ] }, 4 | { "version": "3.1", "title": "3.1-Napa", "aliases": [] }, 5 | { "version": "3.0", "title": "3.0-Minnesota", "aliases": [] }, 6 | { "version": "2.3", "title": "2.3-Levski", "aliases": [] }, 7 | { "version": "2.2", "title": "2.2-Kamakura", "aliases": [] }, 8 | { "version": "2.1", "title": "2.1-Jakarta", "aliases": [] }, 9 | { "version": "2.0", "title": "2.0-Ireland", "aliases": [] }, 10 | { "version": "1.3", "title": "1.3-Hanoi", "aliases": [] }, 11 | { "version": "1.2", "title": "1.2-Geneva", "aliases": [] } 12 | ] 13 | -------------------------------------------------------------------------------- /docs_src/api/Ch-APIIntroduction.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | Each of the EdgeX services (core, supporting, management, device and application) implement a RESTful API. This section provides details about each service's API. You will see there is a common set of API's that all services implement, which are: 4 | 5 | - Version 6 | - Config 7 | - Ping 8 | 9 | Each Edgex Service's RESTful API is documented via Swagger. A link is provided to the swagger document in the service specific documentation. 10 | 11 | Also included in this API Reference are a couple 3rd party services (Configuration/Registry and Rules Engine). These services do not implement the above common APIs and don't have swagger documentation. Links are provided to their appropriate documentation. 12 | 13 | See the left side navigation for complete list of services to access their API Reference. 14 | 15 | -------------------------------------------------------------------------------- /docs_src/api/applications/Ch-APIRulesEngine.md: -------------------------------------------------------------------------------- 1 | # Rules Engine 2 | 3 | EdgeX Foundry Rules Engine Microservice receives data from the instance of App Service Configurable running the `rules-engine` profile (aka app-rules-engine) via the EdgeX MessageBus. EdgeX uses `eKuiper` for the rules engine, which is a separate LF Edge project. See the [eKuiper Website](https://www.lfedge.org/projects/ekuiper/) for more details on this rules engine. 4 | 5 | [eKuiper's documentation](https://github.com/lf-edge/ekuiper/blob/7ef3a19366ee1f4537747fdc2e574389225f5d51/docs/en_US/README.md) 6 | 7 | -------------------------------------------------------------------------------- /docs_src/api/core/Ch-APICoreCommand.md: -------------------------------------------------------------------------------- 1 | # Core Command 2 | 3 | EdgeX Foundry's Command microservice is a conduit for other services to 4 | trigger action on devices and sensors through their managing Device 5 | Services. See [Core Command](../../microservices/core/command/GettingStarted.md) for more details about this service. 6 | 7 | The service provides an API to get the list of commands that 8 | can be issued for all devices or a single device. Commands are divided 9 | into two groups for each device: 10 | 11 | - GET commands are issued to a device or sensor to get a current value 12 | for a particular attribute on the device, such as the current 13 | temperature provided by a thermostat sensor, or the on/off status of 14 | a light. 15 | - SET commands are issued to a device or sensor to change the current 16 | state or status of a device or one of its attributes, such as 17 | setting the speed in RPMs of a motor, or setting the brightness of a 18 | dimmer light. 19 | 20 | ## Swagger 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs_src/api/core/Ch-APICoreKeeper.md: -------------------------------------------------------------------------------- 1 | # Core Keeper 2 | 3 | EdgeX Foundry's Core Keeper microservice is used for Configuration and Registry. See [Configuration and Registry Providers](../../microservices/configuration/ConfigurationAndRegistry.md) for more details about Configuration and Registry. 4 | 5 | ## Swagger 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs_src/api/core/Ch-APICoreMetadata.md: -------------------------------------------------------------------------------- 1 | # Core Metadata 2 | 3 | The Core Metadata microservice includes the device/sensor metadata database 4 | and APIs to expose this database to other services. In particular, the 5 | device provisioning service deposits and manages device metadata through 6 | this service's API. See [Core Metadata](../../microservices/core/metadata/Purpose.md) for more details about this service. 7 | 8 | ## Swagger 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs_src/api/core/Ch-APICoredata.md: -------------------------------------------------------------------------------- 1 | # Core Data 2 | 3 | EdgeX Foundry Core Data microservice communicates with the database to store Events/Readings collected from devices and sensors. 4 | It has APIs to expose this database to other services to allow these services to Add, Query and Delete Events/Readings. See [Core Data](../../microservices/core/data/Purpose.md) for more details about this service. 5 | 6 | ## Swagger 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs_src/api/devices/Ch-APIDeviceSDK.md: -------------------------------------------------------------------------------- 1 | # Device Services 2 | 3 | The EdgeX Foundry Device Service Software Development Kit (SDK) takes the Developer through the step-by-step process to create an EdgeX Foundry Device Service microservice. See [Device Service SDK](../../microservices/device/sdk/Purpose.md) for more details on this SDK. 4 | 5 | The Device Service SDK provides a RESTful API that all Device Services inherit from the SDK. 6 | 7 | ## Swagger 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs_src/api/support/Ch-APISupportNotifications.md: -------------------------------------------------------------------------------- 1 | # Support Notifications 2 | 3 | When a person or a system needs to be informed of something discovered on the node by another microservice on the node, EdgeX Foundry's Support Notifications microservice delivers that information. Examples of Alerts and Notifications that other services might need to broadcast include sensor data detected outside of certain parameters, usually detected by a Rules Engine service, or a system or service malfunction usually detected by system management services. See [Support Notifications](../../microservices/support/notifications/Purpose.md) for more details about this service. 4 | 5 | ## Swagger 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs_src/api/support/Ch-APISupportScheduler.md: -------------------------------------------------------------------------------- 1 | # Support Scheduler 2 | 3 | EdgeX Foundry's Support Scheduler microservice to schedule actions to occur on specific intervals or crontab definition. See Support Scheduler (TBD) for more details about this service. 4 | 5 | ## Swagger 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs_src/assets/logo_edgex.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/assets/logo_edgex.png -------------------------------------------------------------------------------- /docs_src/assets/logo_edgex_white.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/assets/logo_edgex_white.png -------------------------------------------------------------------------------- /docs_src/assets/stylesheets/branding.css: -------------------------------------------------------------------------------- 1 | :root { 2 | 3 | --md-default-fg-color: hsla(0, 0%, 0%, 0.87); 4 | --md-default-fg-color--light: hsla(0, 0%, 0%, 0.54); 5 | --md-default-fg-color--lighter: hsla(0, 0%, 0%, 0.26); 6 | --md-default-fg-color--lightest: hsla(0, 0%, 0%, 0.07); 7 | --md-default-bg-color: hsla(0, 0%, 100%, 1); 8 | --md-default-bg-color--light: hsla(0, 0%, 100%, 0.7); 9 | --md-default-bg-color--lighter: hsla(0, 0%, 100%, 0.3); 10 | --md-default-bg-color--lightest: hsla(0, 0%, 100%, 0.12); 11 | 12 | --md-primary-fg-color: hsla(343, 55%, 37%, 1); 13 | --md-primary-fg-color--light: hsla(343, 55%, 37%, 1); 14 | --md-primary-fg-color--dark: hsla(343, 55%, 37%, 1); 15 | --md-primary-bg-color: hsla(0, 0%, 100%, 1); 16 | --md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7); 17 | 18 | --md-accent-fg-color: hsla(282, 65%, 19%, 1); 19 | --md-accent-fg-color--transparent: hsla(282, 65%, 19%, 0.1); 20 | --md-accent-bg-color: hsla(0, 0%, 100%, 1); 21 | --md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7); 22 | 23 | --md-code-bg-color: hsla(0, 0%, 92.5%, 0.5); 24 | --md-code-fg-color: hsla(200, 18%, 26%, 1); 25 | } 26 | -------------------------------------------------------------------------------- /docs_src/assets/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | .home-nav-column { 2 | float: left; 3 | width: 30%; 4 | padding: 0 10px; 5 | border-top: 5px solid hsla(282,65%,19%,1); 6 | margin: 5px 5px; 7 | } 8 | .home-nav-card { 9 | text-align: center; 10 | } 11 | 12 | .home-nav-row { 13 | margin: 0 -5px; 14 | } 15 | 16 | .home-nav-row:after { 17 | content: ""; 18 | display: table; 19 | clear: both; 20 | } 21 | 22 | .divider { 23 | border-top: 3px solid hsla(282,65%,19%,1); 24 | padding-bottom: 0px; 25 | } 26 | 27 | .home-nav-icons { 28 | vertical-align: middle; 29 | height: 50px; 30 | width: 50px; 31 | margin-right: 0px; 32 | } 33 | 34 | .md-header, .md-tabs { 35 | background-color: hsla(282,65%,19%,1); 36 | } 37 | -------------------------------------------------------------------------------- /docs_src/assets/stylesheets/newexample.css: -------------------------------------------------------------------------------- 1 | /* Added to change the color of examples to be different than edgey */ 2 | .md-typeset .admonition.example, 3 | .md-typeset details.example { 4 | border-color: darkkhaki; 5 | } 6 | .md-typeset .example > .admonition-title, 7 | .md-typeset .example > summary { 8 | background-color: khaki; 9 | } 10 | -------------------------------------------------------------------------------- /docs_src/assets/stylesheets/version-select.css: -------------------------------------------------------------------------------- 1 | #version-selector { 2 | padding: .6rem .8rem; 3 | } 4 | .md-nav__item--nested #version-selector { 5 | padding: .6rem .6rem; 6 | } 7 | #version-selector select { 8 | display: block; 9 | width: 100%; 10 | font-size: .8rem; 11 | } 12 | @media only screen and (min-width:76.1875em) { 13 | .md-nav__item--nested #version-selector { 14 | padding: .6rem .0rem; 15 | } 16 | #version-selector { 17 | padding: .6rem .6rem; 18 | } -------------------------------------------------------------------------------- /docs_src/cloud-upload.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/cloud-upload.png -------------------------------------------------------------------------------- /docs_src/design/Process.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/Process.png -------------------------------------------------------------------------------- /docs_src/design/adr/application/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/adr/command-message-bridge.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/command-message-bridge.png -------------------------------------------------------------------------------- /docs_src/design/adr/command-msg-structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/command-msg-structure.png -------------------------------------------------------------------------------- /docs_src/design/adr/command-msg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/command-msg.png -------------------------------------------------------------------------------- /docs_src/design/adr/command-service-topics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/command-service-topics.png -------------------------------------------------------------------------------- /docs_src/design/adr/common-config-images/EdgeX 2.x Configuration bootstrapping flowchart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/common-config-images/EdgeX 2.x Configuration bootstrapping flowchart.png -------------------------------------------------------------------------------- /docs_src/design/adr/common-config-images/EdgeX 3.x Common Configuration bootstrapping flowchart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/common-config-images/EdgeX 3.x Common Configuration bootstrapping flowchart.png -------------------------------------------------------------------------------- /docs_src/design/adr/common-config-images/EdgeX 3.x Configuration bootstrapping flowchart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/common-config-images/EdgeX 3.x Configuration bootstrapping flowchart.png -------------------------------------------------------------------------------- /docs_src/design/adr/core/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/adr/core/EdgeX_UoM_Validation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/core/EdgeX_UoM_Validation.png -------------------------------------------------------------------------------- /docs_src/design/adr/device-service/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/adr/devops/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/adr/devops/0007/gomods_mergeactions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/devops/0007/gomods_mergeactions.png -------------------------------------------------------------------------------- /docs_src/design/adr/devops/0007/gomods_releaseactions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/devops/0007/gomods_releaseactions.png -------------------------------------------------------------------------------- /docs_src/design/adr/devops/0007/mergeactions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/devops/0007/mergeactions.png -------------------------------------------------------------------------------- /docs_src/design/adr/devops/0007/releaseactions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/devops/0007/releaseactions.png -------------------------------------------------------------------------------- /docs_src/design/adr/devops/0010/known-build-dependencies.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/devops/0010/known-build-dependencies.png -------------------------------------------------------------------------------- /docs_src/design/adr/performance-report.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/performance-report.png -------------------------------------------------------------------------------- /docs_src/design/adr/security/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/adr/security/0020-spiffe-architecture.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/security/0020-spiffe-architecture.jpg -------------------------------------------------------------------------------- /docs_src/design/adr/security/0028-as-is.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/security/0028-as-is.jpg -------------------------------------------------------------------------------- /docs_src/design/adr/security/0028-to-be.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/security/0028-to-be.jpg -------------------------------------------------------------------------------- /docs_src/design/adr/security/0029-as-is.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/security/0029-as-is.jpg -------------------------------------------------------------------------------- /docs_src/design/adr/security/0029-to-be.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/security/0029-to-be.jpg -------------------------------------------------------------------------------- /docs_src/design/adr/security/bootstrap-as-is.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/security/bootstrap-as-is.jpg -------------------------------------------------------------------------------- /docs_src/design/adr/security/bootstrap-to-be.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/adr/security/bootstrap-to-be.jpg -------------------------------------------------------------------------------- /docs_src/design/adr/system-management/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/adr/testqa/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/legacy-design/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/legacy-design/README.md: -------------------------------------------------------------------------------- 1 | # Legacy Design Documents 2 | 3 | | Name/Link | Short Description | 4 | | -------------------------------------------------- | -------------------------------------------- | 5 | | [Registry Abstraction](Registry-Abstraction.pdf) | Decouple EdgeX services from Consul | 6 | | [device-service/Discovery](device-service/discovery.md) | Dynamically discover new devices | 7 | -------------------------------------------------------------------------------- /docs_src/design/legacy-design/Registry-Abstraction.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/legacy-design/Registry-Abstraction.pdf -------------------------------------------------------------------------------- /docs_src/design/legacy-requirements/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/design/legacy-requirements/README.md: -------------------------------------------------------------------------------- 1 | # Legacy Requirements 2 | 3 | | Name/Link | Short Description | 4 | | -------------------------------------------------- | -------------------------------------------- | 5 | | [Device Service](device-service.md) | Device Service SDK required functionality | 6 | 7 | -------------------------------------------------------------------------------- /docs_src/design/ucr/README.md: -------------------------------------------------------------------------------- 1 | # Use Case Records Folder 2 | This folder contains the EdgeX Foundry use case records (UCRs). 3 | 4 | ## Naming and Formatting 5 | UCR documents should include the title in their file name as `Use-Case-Title.md`. E 6 | 7 | EdgeX UCRs should use the [template.md](template) file available in this directory. 8 | 9 | ## Table of Contents 10 | A README with a table of contents for current documents is located [here](../TOC.md). 11 | Document authors are asked to keep the TOC updated with each new document entry. 12 | 13 | Legacy requirements have their own Table of Contents and are located [here](../legacy-requirements). -------------------------------------------------------------------------------- /docs_src/design/ucr/performance-test.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/design/ucr/performance-test.png -------------------------------------------------------------------------------- /docs_src/docker.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/docker.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesDatanabSensor.JPG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesDatanabSensor.JPG -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTApplicationProperties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTApplicationProperties.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTBrokerAddress.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTBrokerAddress.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTCommandTopic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTCommandTopic.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTDeviceCommands.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTDeviceCommands.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTDeviceService.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTDeviceService.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTProject.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTProject.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTRequestsToCoreData.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTRequestsToCoreData.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTTestSender.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTTestSender.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTUiConsole.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTUiConsole.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesMQTTWebsocketUi.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesMQTTWebsocketUi.png -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_ExamplesNI9038.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_ExamplesNI9038.jpg -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_Examples_Patlite.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_Examples_Patlite.jpg -------------------------------------------------------------------------------- /docs_src/examples/EdgeX_Patlite_Green_On.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/EdgeX_Patlite_Green_On.jpg -------------------------------------------------------------------------------- /docs_src/examples/IncomingResponse.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/IncomingResponse.png -------------------------------------------------------------------------------- /docs_src/examples/MQTTBroker.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/MQTTBroker.png -------------------------------------------------------------------------------- /docs_src/examples/MQTTdiagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/MQTTdiagram.png -------------------------------------------------------------------------------- /docs_src/examples/VirtualSequence.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/VirtualSequence.png -------------------------------------------------------------------------------- /docs_src/examples/Virtual_DS.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/Virtual_DS.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/api-log.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/api-log.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/bad-response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/bad-response.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/camera-position.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/camera-position.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/camera.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/camera.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/example-analytics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/example-analytics.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/good-response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/good-response.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/homepage-demo-app-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/homepage-demo-app-1.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/inference-edgex.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/inference-edgex.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/inference-events-default.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/inference-events-default.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/inference-events.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/inference-events.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/multiple-pipelines-default.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/multiple-pipelines-default.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/running-pipelines.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/running-pipelines.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/select-camera.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/select-camera.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/select-pipeline.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/select-pipeline.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/select-profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/select-profile.png -------------------------------------------------------------------------------- /docs_src/examples/app-service-examples/camera-management/images/stop-pipeline.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/app-service-examples/camera-management/images/stop-pipeline.png -------------------------------------------------------------------------------- /docs_src/examples/getcommand_MQTT.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/getcommand_MQTT.png -------------------------------------------------------------------------------- /docs_src/examples/getreading_MQTT.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/getreading_MQTT.png -------------------------------------------------------------------------------- /docs_src/examples/index.md: -------------------------------------------------------------------------------- 1 | # EdgeX Examples 2 | 3 | In addition to the examples listed in this section of the documentation, you will find other examples in the [EdgeX Examples Repository](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}). 4 | 5 | The tabs below provide a listing (may be partial based on latest updates) for reference. 6 | 7 | === "Application Services" 8 | See [App Service Examples](./AppServiceExamples.md) for a listing of custom and configurable application service examples. 9 | 10 | === "Deployment" 11 | |Example|Location| 12 | |---|---| 13 | |Helm (Kubernetes)|[Github - examples, deployment](https://github.com/edgexfoundry/edgex-helm/tree/{{edgexversion}})| 14 | |Raspberry Pi 4|[Github - examples, raspberry-pi-4](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/deployment/raspberry-pi-4)| 15 | 16 | === "Device Services" 17 | |Example|Location| 18 | |---|---| 19 | | TBD | 20 | 21 | === "Security" 22 | |Example|Location| 23 | |---|---| 24 | |security-enabled EdgeX Remote Device Service|[Github - examples, security](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/security/remote_devices/spiffe_and_ssh)| 25 | 26 | 27 | 28 | !!! Warning 29 | Not all the examples in the EdgeX Examples repository are available for all EdgeX releases. Check the documentation for details. 30 | -------------------------------------------------------------------------------- /docs_src/examples/putModbusPal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/putModbusPal.png -------------------------------------------------------------------------------- /docs_src/examples/putbody.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/putbody.png -------------------------------------------------------------------------------- /docs_src/examples/putcommand_MQTT.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/putcommand_MQTT.png -------------------------------------------------------------------------------- /docs_src/examples/scheduleconfig_MQTT.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/examples/scheduleconfig_MQTT.png -------------------------------------------------------------------------------- /docs_src/general/CN-EN.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/CN-EN.png -------------------------------------------------------------------------------- /docs_src/general/CNCF-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/CNCF-logo.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_ApplicationServicesLayer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_ApplicationServicesLayer.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_CoreServicesHighlighted.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_CoreServicesHighlighted.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_CoreServicesLayer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_CoreServicesLayer.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_DeviceServicesLayer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_DeviceServicesLayer.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_RegistryHighlighted.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_RegistryHighlighted.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_Security.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_Security.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_SecurityLayer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_SecurityLayer.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_SupportingServicesLayer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_SupportingServicesLayer.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_X.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_X.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_architecture.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_data-flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_data-flow.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_deployments.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_deployments.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_gateway.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_gateway.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_logo.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_microservice_arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_microservice_arch.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_middleware.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_middleware.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_octopus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_octopus.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step1-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step1-1.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step1-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step1-2.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step2.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step3.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step4.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step5.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step6.png -------------------------------------------------------------------------------- /docs_src/general/EdgeX_step7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/general/EdgeX_step7.png -------------------------------------------------------------------------------- /docs_src/getting-started/Ch-GettingStartedUsers.md: -------------------------------------------------------------------------------- 1 | # Getting Started as a User 2 | 3 | This section provides instructions for Users to get EdgeX up and running. 4 | If you are a Developer, you should read [Getting Started as a Developer](./Ch-GettingStartedDevelopers.md). 5 | 6 | EdgeX is a collection of more than a dozen micro services that 7 | are deployed to provide a minimal edge platform capability. 8 | 9 | You can download EdgeX micro service source code and build your own micro services. 10 | However, if you do not have a need to change or add to EdgeX, then you do not need to download source code. 11 | Instead, you can download and run the pre-built EdgeX micro service artifacts. 12 | 13 | The EdgeX community builds and creates Docker images with each release. 14 | The community also provides the latest unstable builds (prior to releases). 15 | 16 | Please continue by referring to: 17 | 18 | - [Getting Started using Docker](./Ch-GettingStartedDockerUsers.md) 19 | -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX-GettingStartedSnapUsersUI.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX-GettingStartedSnapUsersUI.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_DeviceServiceSDK.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_DeviceServiceSDK.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedBranchSelection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedBranchSelection.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedBuild.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedBuild.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedChangeToNexus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedChangeToNexus.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedClone.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedClone.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedHybridBuild.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedHybridBuild.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedHybridDeviceVirtualLog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedHybridDeviceVirtualLog.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedHybridResults.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedHybridResults.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedHybridRun.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedHybridRun.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedHybridRunContainers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedHybridRunContainers.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedNexusCompose.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedNexusCompose.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedNexusComposeNew.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedNexusComposeNew.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedRunMetadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedRunMetadata.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedUsrActiveContainers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedUsrActiveContainers.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedUsrLogs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedUsrLogs.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GettingStartedUsrPing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GettingStartedUsrPing.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GoLandMakeBuild.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GoLandMakeBuild.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GoLandMakeRun.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GoLandMakeRun.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GoLandOpenProject.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GoLandOpenProject.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GoLandSelectProject.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GoLandSelectProject.png -------------------------------------------------------------------------------- /docs_src/getting-started/EdgeX_GoLandViewTerminal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/EdgeX_GoLandViewTerminal.png -------------------------------------------------------------------------------- /docs_src/getting-started/gcc-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/gcc-logo.png -------------------------------------------------------------------------------- /docs_src/getting-started/golang-vector-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/golang-vector-6.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildAppServiceConf-Windows.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildAppServiceConf-Windows.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildAppServiceConf.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildAppServiceConf.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildDeviceVirtual-Windows.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildDeviceVirtual-Windows.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildDeviceVirtual.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildDeviceVirtual.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildEdgeXGoServices-Windows.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildEdgeXGoServices-Windows.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildEdgeXGoServices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildEdgeXGoServices.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildEssentialCheck.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildEssentialCheck.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildGUI-Windows.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildGUI-Windows.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildGUI.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildGUI.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/BuildeKuiper.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/BuildeKuiper.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/CheckeKuiperRunning-OK.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/CheckeKuiperRunning-OK.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/CheckeKuiperRunning-Oops.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/CheckeKuiperRunning-Oops.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/CreateeKuiperRule.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/CreateeKuiperRule.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/CreateeKuiperStream.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/CreateeKuiperStream.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/DataCenterDisplayData.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/DataCenterDisplayData.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/GitCheck-Windows.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/GitCheck-Windows.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/GitCheck.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/GitCheck.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/GoLangCheck-Windows.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/GoLangCheck-Windows.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/GoLangCheck.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/GoLangCheck.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/LocationConfigAppService.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/LocationConfigAppService.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/LocationDeviceVirtualService.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/LocationDeviceVirtualService.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/LocationEdgeXGUI.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/LocationEdgeXGUI.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/LocationeKuiper-arm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/LocationeKuiper-arm.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/LocationeKuiper.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/LocationeKuiper.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/LocationeKuiperStreamLog-arm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/LocationeKuiperStreamLog-arm.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/LocationeKuiperStreamLog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/LocationeKuiperStreamLog.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/NohupTailFile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/NohupTailFile.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/RunGUI.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/RunGUI.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/StreamOfEventReadings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/StreamOfEventReadings.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/TaileKuiperLog-arm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/TaileKuiperLog-arm.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/TaileKuiperLog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/TaileKuiperLog.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/WindowsEnvVar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/WindowsEnvVar.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/WindowsNewSystemVar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/WindowsNewSystemVar.png -------------------------------------------------------------------------------- /docs_src/getting-started/native/WindowsSystemProperties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/native/WindowsSystemProperties.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_ConnectToHiveMQ.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_ConnectToHiveMQ.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_GettingStartedCommandGet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_GettingStartedCommandGet.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_GettingStartedCommandGetAfterPut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_GettingStartedCommandGetAfterPut.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_GettingStartedCommandPut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_GettingStartedCommandPut.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_GettingStartedRandomIntegerData.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_GettingStartedRandomIntegerData.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_GettingStartedUsrActiveContainers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_GettingStartedUsrActiveContainers.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_HiveMQTTMessages.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_HiveMQTTMessages.png -------------------------------------------------------------------------------- /docs_src/getting-started/quick-start/EdgeX_HiveMQTTWebClient.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/quick-start/EdgeX_HiveMQTTWebClient.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_AddDeviceWizard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_AddDeviceWizard.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_AddeKuiperRule.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_AddeKuiperRule.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_AppServiceConfButton.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_AppServiceConfButton.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_AppServiceList.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_AppServiceList.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_AssocProfileServiceLinks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_AssocProfileServiceLinks.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_AssociatedDeviceIcon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_AssociatedDeviceIcon.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_AssociatedDevicesButton.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_AssociatedDevicesButton.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_CantRemoveProfile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_CantRemoveProfile.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_CommandExecute.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_CommandExecute.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Compose_With_app_sample.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Compose_With_app_sample.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_DSSettings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_DSSettings.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Dashboard.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Dashboard2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Dashboard2.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Dashboard_Error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Dashboard_Error.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_DeviceList.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_DeviceList.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_DeviceProfileList.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_DeviceProfileList.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_EditAutoEvents.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_EditAutoEvents.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_EventStream.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_EventStream.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_GUI_Login.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_GUI_Login.jpg -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_GUI_Mobile.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_GUI_Mobile.jpg -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Hamburger_Icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Hamburger_Icon.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Interval.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Interval.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_IntervalAction.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_IntervalAction.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Menu_Icons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Menu_Icons.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Metadata.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Notifications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Notifications.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_OperationButtons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_OperationButtons.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_ProvisionWatcherList.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_ProvisionWatcherList.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_RuleNoStream.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_RuleNoStream.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Scheduler.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Scheduler.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Service_Metrics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Service_Metrics.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_StoppedService.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_StoppedService.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_Subscriptions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_Subscriptions.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_TokenPrompt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_TokenPrompt.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/EdgeX_eKuiperStream.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/EdgeX_eKuiperStream.png -------------------------------------------------------------------------------- /docs_src/getting-started/tools/update-device.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/getting-started/tools/update-device.png -------------------------------------------------------------------------------- /docs_src/hybrid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/hybrid.png -------------------------------------------------------------------------------- /docs_src/microservices/application/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Services - API Reference 3 | --- 4 | 5 | # Application Services - API Reference 6 | 7 | The following REST APIs are provided by the App SDK and are inherited by all Application Services. 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs_src/microservices/application/ApplicationServices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/ApplicationServices.png -------------------------------------------------------------------------------- /docs_src/microservices/application/SDKFunctions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/SDKFunctions.png -------------------------------------------------------------------------------- /docs_src/microservices/application/TriggersFunctions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/TriggersFunctions.png -------------------------------------------------------------------------------- /docs_src/microservices/application/details/CommandLine.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Services - Command-line Options 3 | --- 4 | 5 | # Application Services - Command-line Options 6 | 7 | See the [Common Command Line Options](../../configuration/CommonCommandLineOptions.md) for the set of command line options common to all EdgeX services. The following command line options are specific to Application Services. 8 | 9 | ### Skip Version Check 10 | 11 | `-s/--skipVersionCheck` 12 | 13 | Indicates the service should skip the Core Service's version compatibility check. 14 | 15 | ### Service Key 16 | 17 | `-sk/--serviceKey` 18 | 19 | Sets the service key that is used with Registry, Configuration Provider and security services. The default service key is set by the application service. If the name provided contains the placeholder text ``, this text will be replaced with the name of the profile used. If profile is not set, the `` text is simply removed 20 | 21 | Can be overridden with [EDGEX_SERVICE_KEY](EnvironmentVariables.md#edgex_service_key) environment variable. 22 | 23 | -------------------------------------------------------------------------------- /docs_src/microservices/application/details/EnvironmentVariables.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Services - Environment Variables 3 | --- 4 | 5 | # Application Services - Environment Variables 6 | 7 | See the [Common Environment Variables](../../configuration/CommonEnvironmentVariables.md) section for the list of environment variables common to all EdgeX Services. The remaining in this section are specific to Application Services. 8 | 9 | ### EDGEX_SERVICE_KEY 10 | 11 | This environment variable overrides the [`-sk/--serviceKey` command-line option](CommandLine.md#service-key) and the default set by the application service. 12 | 13 | !!! note 14 | If the name provided contains the text ``, this text will be replaced with the name of the profile used. 15 | 16 | !!! example "Example - Service Key" 17 | `EDGEX_SERVICE_KEY: app--mycloud` 18 | `profile: http-export` 19 | then service key will be `app-http-export-mycloud` 20 | -------------------------------------------------------------------------------- /docs_src/microservices/application/details/SeedingSecrets.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Services - Seeding Secrets 3 | --- 4 | 5 | # Application Services - Seeding Secrets 6 | 7 | Often application service required their own specific secrets for authentication, encryption, etc. These secrets can be seeded into the service's SecretStore at start-up via a secret seed file. See [Seeding Service Secrets](../../../security/SeedingServiceSecrets.md) security page for more detail. -------------------------------------------------------------------------------- /docs_src/microservices/application/sdk-python/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App SDK for Python - Purpose 3 | --- 4 | 5 | # App Functions SDK for Python - Purpose 6 | 7 | Welcome the App Functions SDK Python for EdgeX. This SDK is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting edge data using Python. 8 | 9 | Use this SDK to create a custom application service when you have data processing needs that are not satisfied by the [Built-In Pipeline Functions](api/BuiltInPipelineFunctions.md). If these functions do satisfy your needs, then check out [App Service Configurable.](../services/AppServiceConfigurable/Purpose.md) 10 | -------------------------------------------------------------------------------- /docs_src/microservices/application/sdk-python/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App SDK for Python - Source Code 3 | --- 4 | 5 | # App Functions SDK for Python - Source Code 6 | 7 | The source code for the App SDK can be found at [https://github.com/edgexfoundry/app-functions-sdk-python](https://github.com/edgexfoundry/app-functions-sdk-python). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/application/sdk-python/details/ErrorHandling.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App SDK - Pipeline Function Error Handling 3 | --- 4 | 5 | # App Functions SDK for Python - Pipeline Function Error Handling 6 | 7 | Each transform returns a `true` or `false` as part of the return signature. This is called the `continuePipeline` flag and indicates whether the SDK should continue calling successive transforms in the pipeline. 8 | 9 | - `return false, nil` will stop the pipeline and stop processing the event. This is useful, for example, when filtering on values and nothing matches the criteria you've filtered on. 10 | - `return false, error`, will stop the pipeline as well and the SDK will log the error you have returned. 11 | - `return true, nil` tells the SDK to continue, and will call the next function in the pipeline with your result. 12 | 13 | The SDK will return control back to main when receiving a SIGTERM/SIGINT event to allow for custom clean up. 14 | 15 | -------------------------------------------------------------------------------- /docs_src/microservices/application/sdk/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App SDK - Purpose 3 | --- 4 | 5 | # App Functions SDK - Purpose 6 | 7 | Welcome the App Functions SDK for EdgeX. This SDK is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting edge data. 8 | 9 | Use this SDK to create a custom application service when you have data processing needs that are not satisfied by the [Built-In Pipeline Functions](api/BuiltInPipelineFunctions.md). If these functions do satisfy your needs, then check out [App Service Configurable.](../services/AppServiceConfigurable/Purpose.md) 10 | -------------------------------------------------------------------------------- /docs_src/microservices/application/sdk/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App SDK - Source Code 3 | --- 4 | 5 | # App Functions SDK - Source Code 6 | 7 | The source code for the App SDK can be found at [https://github.com/edgexfoundry/app-functions-sdk-go/tree/{{edgexversion}}](https://github.com/edgexfoundry/app-service-configurable/tree/{{edgexversion}}). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/application/sdk/details/ErrorHandling.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App SDK - Pipeline Function Error Handling 3 | --- 4 | 5 | # App Functions SDK - Pipeline Function Error Handling 6 | 7 | Each transform returns a `true` or `false` as part of the return signature. This is called the `continuePipeline` flag and indicates whether the SDK should continue calling successive transforms in the pipeline. 8 | 9 | - `return false, nil` will stop the pipeline and stop processing the event. This is useful, for example, when filtering on values and nothing matches the criteria you've filtered on. 10 | - `return false, error`, will stop the pipeline as well and the SDK will log the error you have returned. 11 | - `return true, nil` tells the SDK to continue, and will call the next function in the pipeline with your result. 12 | 13 | The SDK will return control back to main when receiving a SIGTERM/SIGINT event to allow for custom clean up. 14 | 15 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App RFID LLRP Inventory - Introduction 3 | --- 4 | 5 | # App RFID LLRP Inventory - Introduction 6 | 7 | Edgex application service for processing raw LLRP tag reads, producing events [Arrived, Moved, Departed], configure and manage LLRP readers via commands 8 | 9 | See [README](https://github.com/edgexfoundry/app-rfid-llrp-inventory/tree/{{edgexversion}}/README.md) for details -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App RFID LLRP Inventory - API Reference 3 | --- 4 | 5 | # App RFID LLRP Inventory - API Reference 6 | 7 | In addition to the APIs listed below, this service inherits the [common APIs](../../ApiReference.md) from the App SDK. 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App RFID LLRP Inventory - Purpose 3 | --- 4 | 5 | # App RFID LLRP Inventory - Purpose 6 | 7 | This service produces inventory **(Arrived, Moved, Departed)** events from the raw LLRP tag readings produced by the [RFID LLRP Device Service](../../../device/services/device-rfid-llrp.md). It also configures and manages LLRP readers via commands to the [RFID LLRP Device Service](../../../device/services/device-rfid-llrp.md). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App RFID LLRP Inventory - Source Code 3 | --- 4 | 5 | # App RFID LLRP Inventory - Source Code 6 | 7 | The source code for App RFID LLRP Inventory can be found at [https://github.com/edgexfoundry/app-rfid-llrp-inventory/tree/{{edgexversion}}](https://github.com/edgexfoundry/app-record-replay/tree/{{edgexversion}}). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/details/aliases.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/services/AppLLRPInventory/details/aliases.png -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/details/consul_alias_folder.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/services/AppLLRPInventory/details/consul_alias_folder.png -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/details/consul_kv_pairs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/services/AppLLRPInventory/details/consul_kv_pairs.png -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/details/mobility-profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/services/AppLLRPInventory/details/mobility-profile.png -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppLLRPInventory/details/tag-state-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/application/services/AppLLRPInventory/details/tag-state-diagram.png -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppRecordReplay/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Record Replay - API Reference 3 | --- 4 | 5 | # App Record and Replay - API Reference 6 | 7 | Control of this service is accomplished via the following REST API. In addition, 8 | this service does inherit the [common APIs](../../../../api/Ch-APIIntroduction.md) and 9 | the [Trigger API](../../details/Triggers.md#http-trigger) from the SDK. 10 | 11 | 12 | 13 | 14 | ## Postman Collection 15 | 16 | A sample Postman collection can be found [here](https://github.com/edgexfoundry/app-record-replay/blob/{{edgexversion}}/Record%20and%20Reply.postman_collection.json). 17 | 18 | !!! note 19 | Use the Postman `Send and Download` option for the `Export recording - JSON` request so that the response can be saved to file. The `Send and Download` option is on the `Send` button. 20 | 21 | !!! note 22 | Postman automatically decompresses the responses when requesting GZIB or ZLIB compression. Use the following curl command to save the compressed response to file. 23 | 24 | ```text 25 | curl localhost:59712/api/{{api_version}}/data?compression=gzip -o test.gz 26 | curl localhost:59712/api/{{api_version}}/data?compression=zlib -o test.zlib 27 | ``` 28 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppRecordReplay/Configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Record Replay - Configuration 3 | --- 4 | 5 | # App Record and Replay - Configuration 6 | 7 | This service does not have addition configuration to that provided by the App SDK. 8 | See [Application Service Configuration](../../Configuration.md) section for details on the common application service configuration. 9 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppRecordReplay/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Record Replay - Purpose 3 | --- 4 | 5 | # App Record and Replay - Purpose 6 | 7 | This service is a developer testing tool which will record Events from the EdgeX MessageBus and replay them back to the EdgeX MessageBus at a later time. The value of this is a session with devices present can be recorded for later replay on a system which doesn't have the required devices. This allows for testing of services that receive and process the Events without requiring the devices to be present. 8 | 9 | !!! note 10 | The source device service must be running when data is imported since the devices and device profiles are captured as part of the recorded data will be added to the system during import. 11 | 12 | !!! warning - "Storage Model" 13 | Since this is targeted as a developer testing tool, the storage model is kept simple by using in-memory storage for the recorded data. This should be kept in mind when recording or importing a recoding on systems with limited resources. 14 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppRecordReplay/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Record Replay - Source Code 3 | --- 4 | 5 | # App Record and Replay - Source Code 6 | 7 | The source code for Application Service Configurable can be found at [https://github.com/edgexfoundry/app-record-replay/tree/{{edgexversion}}](https://github.com/edgexfoundry/app-record-replay/tree/{{edgexversion}}). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppServiceConfigurable/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Service Configurable - API Reference 3 | --- 4 | 5 | # App Service Configurable - API Reference 6 | 7 | Application Service Configurable does not add any additional REST APIs. It does inherit the [Common App Service APIs](../../ApiReference.md) from the SDK. 8 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppServiceConfigurable/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Service Configurable - Purpose 3 | --- 4 | 5 | # App Service Configurable - Purpose 6 | 7 | The purpose of App Service Configurable is to provide an easy way to get started with processing data flowing through EdgeX. 8 | This service leverages the [App Functions SDK](https://github.com/edgexfoundry/app-functions-sdk-go) and provides a way for 9 | developers to use configuration instead of code to utilize the built-in pipeline functions from the SDK. 10 | Please refer to [Available Configurable Pipeline Functions](details/AvailablePipelineFunctions.md) section below for 11 | full list of built-in functions that can be used in the configurable pipeline. 12 | -------------------------------------------------------------------------------- /docs_src/microservices/application/services/AppServiceConfigurable/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: App Service Configurable - Source Code 3 | --- 4 | 5 | # App Service Configurable - Source Code 6 | 7 | The source code for Application Service Configurable can be found at [https://github.com/edgexfoundry/app-service-configurable/tree/{{edgexversion}}](https://github.com/edgexfoundry/app-service-configurable/tree/{{edgexversion}}). 8 | 9 | -------------------------------------------------------------------------------- /docs_src/microservices/configuration/EdgeX_ConfigurationRegistry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/configuration/EdgeX_ConfigurationRegistry.png -------------------------------------------------------------------------------- /docs_src/microservices/configuration/EdgeX_CoreRegConfig.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/configuration/EdgeX_CoreRegConfig.png -------------------------------------------------------------------------------- /docs_src/microservices/configuration/EdgeX_RegistryHighlighted.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/configuration/EdgeX_RegistryHighlighted.png -------------------------------------------------------------------------------- /docs_src/microservices/core/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/microservices/core/Ch-CoreServices.md: -------------------------------------------------------------------------------- 1 | # Core Services 2 | 3 | ![image](EdgeX_CoreServices.png) 4 | 5 | Core services provide the intermediary between the [north and south sides](../../general/Definitions.md#south-and-north-side) of EdgeX. As the name of these services implies, they are “core” to EdgeX functionality. Core services is where the innate knowledge of “things” connected, sensor data collected, and EdgeX configuration resides. Core consists of the following micro services: 6 | 7 | - [Core data](./data/Purpose.md): a persistence repository and associated management service for data collected from south side objects. 8 | - [Command](./command/Purpose.md): a service that facilitates and controls actuation requests from the north side to the south side. 9 | - [Metadata](./metadata/Purpose.md): a repository and associated management service of metadata about the objects that are connected to EdgeX Foundry. Metadata provides the capability to provision new devices and pair them with their owning device services. 10 | - [Registry and Configuration](../configuration/ConfigurationAndRegistry.md): provides other EdgeX Foundry micro services with information about associated services within the system and micro services configuration properties (i.e. - a repository of initialization values). 11 | -------------------------------------------------------------------------------- /docs_src/microservices/core/EdgeX_CoreServices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/EdgeX_CoreServices.png -------------------------------------------------------------------------------- /docs_src/microservices/core/command/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Core Command - API Reference 3 | --- 4 | 5 | # Core Core Command - API Reference 6 | 7 | The Core Core Command microservice is a conduit for other services to trigger action on devices and sensors through their managing Device Services. 8 | -------------------------------------------------------------------------------- /docs_src/microservices/core/command/EdgeX_Command.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/command/EdgeX_Command.png -------------------------------------------------------------------------------- /docs_src/microservices/core/command/EdgeX_CommandPutRequest.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/command/EdgeX_CommandPutRequest.png -------------------------------------------------------------------------------- /docs_src/microservices/core/command/EdgeX_CommandRequestForDevices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/command/EdgeX_CommandRequestForDevices.png -------------------------------------------------------------------------------- /docs_src/microservices/core/command/EdgeX_CoreCommandModel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/command/EdgeX_CoreCommandModel.png -------------------------------------------------------------------------------- /docs_src/microservices/core/command/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Core Command - Source Code 3 | --- 4 | 5 | # Core Command - Source Code 6 | 7 | The source code for Core Command can be found within edgex-go at 8 | [https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/core-command](https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/core-command). -------------------------------------------------------------------------------- /docs_src/microservices/core/data/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Core Data - API Reference 3 | --- 4 | 5 | # Core Data - API Reference 6 | 7 | EdgeX Foundry Core Data microservice communicates with the database to store Events/Readings collected from devices and sensors. 8 | It has APIs to expose this database to other services to allow these services to Add, Query and Delete Events/Readings. 9 | 10 | -------------------------------------------------------------------------------- /docs_src/microservices/core/data/EdgeX_CoreData.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/data/EdgeX_CoreData.png -------------------------------------------------------------------------------- /docs_src/microservices/core/data/EdgeX_CoreDataRESTEndpoint.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/data/EdgeX_CoreDataRESTEndpoint.png -------------------------------------------------------------------------------- /docs_src/microservices/core/data/EdgeX_CoreDataSubscriber.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/data/EdgeX_CoreDataSubscriber.png -------------------------------------------------------------------------------- /docs_src/microservices/core/data/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Core Data - Source Code 3 | --- 4 | 5 | # Core Data - Source Code 6 | 7 | The source code for Core Data can be found within edgex-go at 8 | [https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/core-data](https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/core-data). -------------------------------------------------------------------------------- /docs_src/microservices/core/data/details/EdgeX_Event-Reading.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/data/details/EdgeX_Event-Reading.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Core Metadata - API Reference 3 | --- 4 | 5 | # Core Metadata - API Reference 6 | 7 | The Core Metadata microservice includes the device/sensor metadata database and APIs to expose this database to other services. In particular, the device provisioning service deposits and manages device metadata through this service's API. 8 | 9 | -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_DS_Access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_DS_Access.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_Metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_Metadata.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_Metadata2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_Metadata2.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_Metadata3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_Metadata3.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_MetadataAddDeviceProfileStep1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_MetadataAddDeviceProfileStep1.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_MetadataAddDeviceProfileStep2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_MetadataAddDeviceProfileStep2.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_MetadataDeviceStartup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_MetadataDeviceStartup.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_MetadataModel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_MetadataModel.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_MetadataModel_Commands.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_MetadataModel_Commands.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_MetadataModel_Profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_MetadataModel_Profile.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/EdgeX_MetadataModel_ProvisionWatcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/core/metadata/EdgeX_MetadataModel_ProvisionWatcher.png -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Core Metadata - Purpose 3 | --- 4 | 5 | # Core Metadata - Purpose 6 | 7 | The core metadata micro service manages the knowledge about [devices](../../../general/Definitions.md#device) and sensors. This information is used by other services (Device, Command, etc) to communicate with the devices. 8 | 9 | Specifically, metadata has the following abilities: 10 | 11 | - Manages information about the devices connected to, and operated by, EdgeX Foundry 12 | - Knows the type, and organization of data reported by the devices 13 | - Knows how to command the devices 14 | 15 | Although metadata has the knowledge, it does not do the following activities: 16 | 17 | - It is not responsible for actual data collection from devices, which is performed by device services and core data 18 | - It is not responsible for issuing commands to the devices, which is performed by core command and device 19 | services 20 | 21 | ![image](EdgeX_Metadata.png) -------------------------------------------------------------------------------- /docs_src/microservices/core/metadata/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Core Metadata - Source Code 3 | --- 4 | 5 | # Core Metadata - Source Code 6 | 7 | The source code for Core Metadata can be found within edgex-go at 8 | [https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/core-metadata](https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/core-metadata). -------------------------------------------------------------------------------- /docs_src/microservices/device/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service - API Reference 3 | --- 4 | 5 | # Device Service - API Reference 6 | 7 | The following REST APIs are provided by the Device Services SDK and are inherited by all Device Services. 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs_src/microservices/device/EdgeX_Device.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/EdgeX_Device.png -------------------------------------------------------------------------------- /docs_src/microservices/device/EdgeX_DeviceServiceAbstraction.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/EdgeX_DeviceServiceAbstraction.png -------------------------------------------------------------------------------- /docs_src/microservices/device/EdgeX_DeviceServices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/EdgeX_DeviceServices.png -------------------------------------------------------------------------------- /docs_src/microservices/device/details/Auto_Events.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/details/Auto_Events.png -------------------------------------------------------------------------------- /docs_src/microservices/device/details/CommandLine.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service - Command-line Options 3 | --- 4 | 5 | # Device Service - Command-line Options 6 | 7 | See the [Common Command Line Options](../../configuration/CommonCommandLineOptions.md) for the set of command line options common to all EdgeX services. The following command line options are specific to Device Service. 8 | 9 | ### Running multiple instances 10 | 11 | `--instance` or `-i` 12 | 13 | Device services support one additional command-line argument, `--instance` or `-i`. 14 | 15 | This allows for running multiple instances of a device service in an EdgeX deployment, by giving them different names. For example, running `device-modbus -i 1` results in a service named `device-modbus_1`, ie the parameter given to the `instance` argument is added as a suffix to the device service name. The same effect may be obtained by setting the [EDGEX_INSTANCE_NAME](./EnvironmentVariables.md) environment variable. 16 | -------------------------------------------------------------------------------- /docs_src/microservices/device/details/Device.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/details/Device.png -------------------------------------------------------------------------------- /docs_src/microservices/device/details/Device_Command.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/details/Device_Command.png -------------------------------------------------------------------------------- /docs_src/microservices/device/details/EnvironmentVariables.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service - Environment Variables 3 | --- 4 | 5 | # Device Service - Environment Variables 6 | 7 | See the [Common Environment Variables](../../configuration/CommonEnvironmentVariables.md) section for the list of environment variables common to all EdgeX Services. The remaining in this section are specific to Device Service. 8 | 9 | ### EDGEX_INSTANCE_NAME 10 | 11 | This environment variable overrides the [`-i/--instance` command-line option](CommandLine.md#running-multiple-instances) and the default set by the device service. 12 | -------------------------------------------------------------------------------- /docs_src/microservices/device/details/SeedingSecrets.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service - Seeding Secrets 3 | --- 4 | 5 | # Device Service - Seeding Secrets 6 | 7 | Often device service required their own specific secrets for authentication, encryption, etc. These secrets can be seeded into the service's SecretStore at start-up via a secret seed file. See [Seeding Service Secrets](../../../security/SeedingServiceSecrets.md) security page for more detail. 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/details/ServiceMetrics.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service - Service Metrics 3 | --- 4 | 5 | # Device Service - Service Metrics 6 | 7 | All device services have the following built-in metrics: 8 | 9 | | Metric Name | Type | Description | 10 | | ----------------------------- | --------- | ------------------------------------------------------------ | 11 | | EventsSent | bool | Enable/disable reporting of the built-in **EventsSent** metric | 12 | | ReadingsSent | bool | Enable/disable reporting of the built-in **ReadingsSent** metric | 13 | | LastConnected | bool | Enable/disable reporting of the built-in **LastConnected** metric| 14 | 15 | See [Custom Service Metrics](../sdk/details/CustomServiceMetrics.md) page for details on creating additional service metrics in a custom device service. 16 | -------------------------------------------------------------------------------- /docs_src/microservices/device/how-to/Ch-RemoteSecure.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service - Remote deployment secure mode 3 | --- 4 | 5 | # Device Service - Remote deployment secure mode 6 | 7 | Coming Soon. 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/EdgeX_SDKs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/EdgeX_SDKs.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service SDK - Source Code 3 | --- 4 | 5 | # Go Device Service SDK - Source Code 6 | 7 | The source code for the Go Device Services SDK can be found at [https://github.com/edgexfoundry/device-sdk-c/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-sdk-go/tree/{{edgexversion}}). 8 | 9 | # C Device Service SDK - Source Code 10 | 11 | The source code for the C Device Services SDK can be found at [https://github.com/edgexfoundry/device-sdk-c/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-sdk-c/tree/{{edgexversion}}). 12 | -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/details/CustomRestApis.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Service SDK - Custom REST APIs 3 | --- 4 | 5 | # Device Service SDK - Custom REST APIs 6 | 7 | You can customize your own REST APIs when building a Device Service but a few routes are reserved and cannot be used: 8 | 9 | - /api/{{api_version}}/version 10 | - /api/{{api_version}}/ping 11 | - /api/{{api_version}}/config 12 | - /api/{{api_version}}/trigger 13 | - /api/{{api_version}}/secret 14 | 15 | To add your own route, use the `AddCustomRoute()` API provided on the `DeviceService` interface. 16 | 17 | !!! example "Example - Add Custom REST route" 18 | 19 | ``` go 20 | AddCustomRoute(route string, authentication Authentication, handler func(e echo.Context) error, methods ...string) error 21 | ``` 22 | 23 | Under the hood, this simply adds the provided route, handler, and method to the `echo` router used in the SDK. For more information on `echo` you can check out the GitHub repo [here](https://github.com/labstack/echo). 24 | You can access the `interfaces.DeviceService` API for resources such as the logging client by pulling it from the context as shown above -- this is useful for when your routes might not be defined in your `main.go` where you have access to the ``interfaces.DeviceService`` instance. 25 | -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/details/DeviceCommands.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/details/DeviceCommands.md -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedGoModInit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedGoModInit.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedLocateDriver.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedLocateDriver.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKBuild.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKBuild.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKClone.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKClone.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKCompileC.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKCompileC.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKCopyFiles.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKCopyFiles.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKCopyFilesC.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKCopyFilesC.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKGoAddImports.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKGoAddImports.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKGoGenNumber.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKGoGenNumber.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKGoMod.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKGoMod.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKReplaceImports.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_GettingStartedSDKReplaceImports.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_SampleDeviceProfile_DeviceResources.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_SampleDeviceProfile_DeviceResources.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_SampleDeviceProfile_DeviceResourcesC.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/sdk/devicesdk-getting-started/EdgeX_SampleDeviceProfile_DeviceResourcesC.png -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/configuration.yaml: -------------------------------------------------------------------------------- 1 | Writable: 2 | LogLevel: INFO 3 | Reading: 4 | ReadingUnits: true 5 | Telemetry: 6 | Metrics: 7 | # All service's custom metric names must be present in this list. All common metric names are in the Common Config 8 | ReadCommandsExecuted: true 9 | Service: 10 | Host: "localhost" 11 | Port: 59999 # Device service are assigned the 599xx range 12 | StartupMsg: device simple started 13 | 14 | Clients: 15 | core-metadata: 16 | Host: localhost 17 | Port: 59881 18 | 19 | MessageBus: 20 | Protocol: mqtt 21 | Host: localhost 22 | Port: 6379 23 | Type: mqtt 24 | AuthMode: "usernamepassword" # required for mqtt messagebus (secure or insecure) 25 | SecretName: mqtt-bus 26 | Optional: 27 | ClientId: device-example 28 | 29 | # Example overriding of Common Config settings 30 | Device: 31 | AsyncBufferSize: 1 32 | # These have common values (currently), but must be here for service local env overrides to apply when customized 33 | ProfilesDir: "./res/profiles" 34 | DevicesDir: "./res/devices" 35 | # Only needed if device service implements auto provisioning 36 | ProvisionWatchersDir: ./res/provisionwatchers 37 | # Example structured custom configuration 38 | SimpleCustom: 39 | OnImageLocation: ./res/on.png 40 | OffImageLocation: ./res/off.jpg 41 | Writable: 42 | DiscoverSleepDurationSecs: 10 43 | -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/random-generator-devices.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "name": "RandNum-Device01", 4 | "profileName": "RandNum-Device", 5 | "description": "Random Number Generator Device", 6 | "labels": [ 7 | "test", 8 | "random" 9 | ], 10 | "protocols": { 11 | "Other": { 12 | "Address": "random", 13 | "Port": 300 14 | } 15 | }, 16 | "autoEvents": [ 17 | { 18 | "interval": "10s", 19 | "sourceName": "RandomNumber", 20 | "onChange": false 21 | } 22 | ] 23 | } 24 | ] 25 | -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/random-generator-devices.yaml: -------------------------------------------------------------------------------- 1 | deviceList: 2 | - name: RandNum-Device01 3 | profileName: RandNum-Device 4 | description: "Random Number Generator Device" 5 | labels: 6 | - test 7 | - random 8 | protocols: 9 | other: 10 | Address: random 11 | Port: 300 12 | autoEvents: 13 | - interval: 10s 14 | sourceName: RandomNumber 15 | onChange: false 16 | -------------------------------------------------------------------------------- /docs_src/microservices/device/sdk/devicesdk-getting-started/random-generator.yaml: -------------------------------------------------------------------------------- 1 | name: "RandNum-Device" 2 | manufacturer: "Dell Technologies" 3 | model: "1" 4 | labels: 5 | - "random" 6 | - "test" 7 | description: "random number generator to simulate a device" 8 | deviceResources: 9 | - name: "RandomNumber" 10 | description: "generated random number" 11 | attributes: 12 | { type: "random" } 13 | properties: 14 | valueType: "Int32" 15 | readWrite: "R" 16 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-bacnet.md: -------------------------------------------------------------------------------- 1 | # Device BACNET 2 | 3 | Device service for BACnet protocol written in C. This service may be built to support BACnet devices connected via ethernet (/IP) or serial (/MSTP). 4 | 5 | See [README](https://github.com/edgexfoundry/device-bacnet-c/tree/{{edgexversion}}#readme) for more details -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-coap.md: -------------------------------------------------------------------------------- 1 | # Device COAP 2 | 3 | Device service for CoAP-based REST protocol 4 | 5 | See [README](https://github.com/edgexfoundry/device-coap-c/tree/{{edgexversion}}#readme) for more details -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-gpio/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device GPIO - API Reference 3 | --- 4 | 5 | # Device GPIO - API Reference 6 | 7 | Device GPIO inherits its REST APIs from the [Device Services SDK](../../ApiReference.md). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-gpio/Configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device GPIO - Configuration 3 | --- 4 | 5 | # Device GPIO - Configuration 6 | 7 | This service defines the following **Driver** configuration settings in addition to the configuration to that provided by the Device SDK. 8 | See [Device Service Configuration](../../Configuration.md) section for details on the common device service configuration. 9 | 10 | | Name | Default Value | Description | 11 | |---------------------|---------------|----------------------------------------------------------------------------------------------------| 12 | | Driver.Interface | "sysfs" | GPIO interface to use. Valid values are `sysfs` and `chardev`. Note that `chardev` is experimental | 13 | | Driver.ChipSelected | "0" | Chip to select when using `chardev` interface | 14 | 15 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-gpio/ProtocolProperties.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device GPIO - Protocol Properties 3 | --- 4 | 5 | # Device GPIO - Protocol Properties 6 | 7 | This device service does not define any device specific protocol properties. Any protocol properties specified in the Device Definition are ignored. 8 | The GPIO protocol specifics are specified in the `attributes` for each resource in the Device Profile. See [Example Resource](./GettingStarted.md#direction-setting-with-sysfs) in walk-thru section for more details. 9 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-gpio/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device GPIO - Purpose 3 | --- 4 | 5 | # Device GPIO - Purpose 6 | 7 | The purpose of this device service is to connect GPIO devices to EdgeX. It uses sysfs ABI (default) or chardev ABI (experimental) to control connected GPIO devices. 8 | 9 | This device service is contributed by [Jiangxing Intelligence](https://www.jiangxingai.com/) 10 | 11 | !!! note 12 | This device service ONLY works on Linux systems 13 | 14 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-gpio/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device GPIO - Source Code 3 | --- 4 | 5 | # Device GPIO - Source Code 6 | 7 | The source code for Device GPIO can be found at [https://github.com/edgexfoundry/device-gpio/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-gpio/tree/{{edgexversion}}). 8 | 9 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/APIReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Modbus - API Reference 3 | --- 4 | 5 | # Device Modbus - API Reference 6 | 7 | This service inherits the [Common Device Service APIs](../../ApiReference.md) from the SDK. 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/Configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Modbus - Configuration 3 | --- 4 | 5 | # Device Modbus - Configuration 6 | 7 | This service does not have addition configuration to that provided by the Device SDK. 8 | See [Device Service Configuration](../../Configuration.md) section for details on the common device service configuration. -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_addmockdevice.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_addmockdevice.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_addregister.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_addregister.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_addvaluegen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_addvaluegen.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_bindvaluegen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_bindvaluegen.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_run.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-modbus/EdgeX_ExampleModbus_simulator_run.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Modbus - Purpose 3 | --- 4 | 5 | # Device Modbus - Purpose 6 | The purpose of the service is to connect Modbus devices to EdgeX. 7 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device Modbus - Source Code 3 | --- 4 | 5 | # Device Modbus - Source Code 6 | 7 | The source code for Device MODBUS can be found at [https://github.com/edgexfoundry/device-modbus-go/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-modbus-go/tree/{{edgexversion}}). -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/details/ModbusReadConversion.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-modbus/details/ModbusReadConversion.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-modbus/details/ModbusWriteConversion.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-modbus/details/ModbusWriteConversion.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt.md: -------------------------------------------------------------------------------- 1 | # Device MQTT 2 | 3 | Device service for connecting a MQTT enabled devices to EdgeX. 4 | 5 | See [README](https://github.com/edgexfoundry/device-mqtt-go/tree/{{edgexversion}}#readme) for more details 6 | 7 | Also see [Adding MQTT Device Tutorial](../services/device-mqtt/Ch-ExamplesAddingMQTTDevice.md) for 8 | more details on using Device MQTT. -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt/APIReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device MQTT - API Reference 3 | --- 4 | 5 | # Device MQTT - API Reference 6 | 7 | Device MQTT inherits its REST APIs from the [Device Services SDK](../../ApiReference.md). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt/EdgeX_ExamplesMQTTDeviceSimulator.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-mqtt/EdgeX_ExamplesMQTTDeviceSimulator.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt/GettingStarted.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device MQTT - Getting Started 3 | --- 4 | 5 | # Device MQTT - Getting Started 6 | 7 | ## Overview 8 | 9 | Device MQTT is a device service for connecting a device or sensor feed to EdgeX using the MQTT protocol. 10 | 11 | ## Running Services with Device MQTT 12 | 13 | The simplest way to run all the required services is to use the [Compose Builder](https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}/compose-builder) tool from a terminal window. 14 | 15 | 1. Clone [https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}](https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}) 16 | 17 | 2. Change to the **compose-builder** folder 18 | 19 | 3. Run the services 20 | ``` 21 | make run ds-mqtt mqtt-broker no-secty 22 | ``` 23 | This runs, in non-secure mode, all the standard EdgeX services, an mqtt message broker, and device MQTT. 24 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt/MQTT_Example_Overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-mqtt/MQTT_Example_Overview.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt/ProtocolProperties.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device MQTT - Protocol Properties 3 | --- 4 | 5 | # Device MQTT - Protocol Properties 6 | 7 | This service defines the following Protocol Properties for each defined device that supports 2-way communications. These properties reside under the `mqtt` key in the `protocols` section of each device definition. 8 | 9 | | Property | Description | 10 | |--------------|----------------------------------------------------| 11 | | CommandTopic | Base MQTT topic for sending commands to the device | 12 | 13 | !!! note 14 | These Protocol Properties are not used/needed for MQTT devices if the data is sent asynchronously. 15 | 16 | !!! example - "Example MQTT Protocol Properties" 17 | 18 | ```yaml 19 | protocols: 20 | mqtt: 21 | CommandTopic: "command/MQTT-test-device" 22 | ``` 23 | 24 | For more information on Commands see [Commanding](details/MultiLevelTopics.md#commanding). -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device MQTT - Purpose 3 | --- 4 | 5 | # Device MQTT - Purpose 6 | 7 | The Device MQTT Microservice is a device service used for connecting devices/sensors to EdgeX using the MQTT protocol. Target devices and this device service connect to the same MQTT broker and exchange messages for async data and device commands. -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-mqtt/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device MQTT - Source Code 3 | --- 4 | 5 | # Device MQTT - Source Code 6 | 7 | The source code for Device MQTT can be found at [https://github.com/edgexfoundry/device-mqtt-go/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-mqtt-go/tree/{{edgexversion}}). -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDashboard.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDeviceList.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDeviceList.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDeviceProfiles.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDeviceProfiles.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDeviceServices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/EdgeXDeviceServices.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/EdgeXJWTLogin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/EdgeXJWTLogin.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/ONVIFDeviceServiceArch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/ONVIFDeviceServiceArch.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/add-device-sequence.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/add-device-sequence.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-add-rule.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-add-rule.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-example.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-example.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-analytics-module-options-1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-analytics-module-options-1.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-analytics-module-options-2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-analytics-module-options-2.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-analytics-module.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-analytics-module.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-rules.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/api-analytic-support-query-rules.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/auto-discovery-docker-overview.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/auto-discovery-docker-overview.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/auto-discovery-flowchart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/auto-discovery-flowchart.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/auto-discovery.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/auto-discovery.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/connect-existing-device.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/connect-existing-device.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/credential-lookup-during-discovery.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/credential-lookup-during-discovery.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-acl.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-acl.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-edit-method.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-edit-method.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-edit-password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-edit-password.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-edit-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-edit-user.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-mac-multiple.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-mac-multiple.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-mac.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-mac.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-method.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-method.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-name.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-password.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-pick-existing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-pick-existing.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-pick.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-pick.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/creds-username.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/creds-username.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/getting-started-with-docker-consul-keyvalue.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/getting-started-with-docker-consul-keyvalue.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/getting-started-with-docker-consul.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/getting-started-with-docker-consul.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/onvif-user-authentication-flow.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/onvif-user-authentication-flow.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/onvif-user-authentication-usernametoken.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/onvif-user-authentication-usernametoken.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/onvif-user-authentication.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/onvif-user-authentication.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/images/status-flowchart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-onvif-camera/images/status-flowchart.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/supplementary-info/control-plane-events.md: -------------------------------------------------------------------------------- 1 | # Control Plane Events 2 | 3 | ## Introduction 4 | Control plane events have been added to enable the Core Metadata to emit events onto the message bus when a device has been added, updated, or deleted. 5 | 6 | Refer [Device System Events](../../../../core/metadata/details/DeviceSystemEvents.md) for more information. 7 | 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/supplementary-info/onvif-footnotes.md: -------------------------------------------------------------------------------- 1 | # ONVIF Footnotes 2 | 3 | !!! warning 4 | Information in this page may be outdated. 5 | 6 | ## Command Support 7 | 8 | ### Tapo C200 - User Management 9 | Tapo returns `200 OK` for all User Management commands, but none of them actually 10 | do anything. The only way to modify the users is through the Tapo app. 11 | 12 | ### Tapo C200 - SetSystemDateAndTime 13 | Tapo does not support setting the `DaylightSavings` field to `false`. Regardless of the setting, the camera will always use daylight savings time. 14 | 15 | ### Bosch - GetSnapshot 16 | You must use `Digest Auth` or `Both` as the Auth-Mode in order for this to work. 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-onvif-camera/swagger.md: -------------------------------------------------------------------------------- 1 | # Device ONVIF Swagger API Documentation 2 | Use this RESTful API documentation to learn more about the capabilities of the device service. 3 | 4 | 5 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-opc-ua/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device OPC-UA - API Reference 3 | --- 4 | 5 | # Device OPC-UA - API Reference 6 | 7 | This service inherits the [Common Device Service APIs](../../ApiReference.md) from the SDK. 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-opc-ua/EdgeX_ExampleOPCUA_simulation_objects.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-opc-ua/EdgeX_ExampleOPCUA_simulation_objects.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-opc-ua/EdgeX_ExampleOPCUA_simulation_startup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-opc-ua/EdgeX_ExampleOPCUA_simulation_startup.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-opc-ua/EdgeX_ExampleOPCUA_simulation_status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-opc-ua/EdgeX_ExampleOPCUA_simulation_status.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-opc-ua/ProtocolProperties.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device OPC-UA - Protocol Properties 3 | --- 4 | 5 | # Device OPC-UA - Protocol Properties 6 | 7 | Device OPC-UA defines the following Protocol Properties for `opcua`. 8 | 9 | These properties reside under the `opcua` key in the protocols section of each device definition. 10 | 11 | | Property | Description | 12 | | -------- | ------------------------------------------------- | 13 | | Endpoint | The `Connection Address(UA TCP)` of OPC-UA server | 14 | 15 | !!! example "Example opcua Protocol Properties" 16 | 17 | ```yaml 18 | ... 19 | protocols: 20 | opcua: 21 | Endpoint: "opc.tcp://jiekemacbookpro14.lan:53530/OPCUA/SimulationServer" 22 | ``` 23 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-opc-ua/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device OPC-UA - Purpose 3 | --- 4 | 5 | # Device OPC-UA - Purpose 6 | 7 | The purpose of the service is to connect OPC-UA devices to EdgeX. 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-opc-ua/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device OPC-UA - Source Code 3 | --- 4 | 5 | # Device OPC-UA - Source Code 6 | 7 | The source code for Device OPC-UA can be found at [https://github.com/edgexfoundry/device-opc-ua/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-opc-ua/tree/{{edgexversion}}). 8 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-rest/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device REST - API Reference 3 | --- 4 | 5 | # Device REST - API Reference 6 | 7 | In addition to the REST API below, this service inherits the [Common Device Service APIs](../../ApiReference.md) from the SDK. 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-rest/Configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device REST - Configuration 3 | --- 4 | 5 | # Device REST - Configuration 6 | 7 | This service does not have additional configuration to that provided by the Device SDK. 8 | See [Device Service Configuration](../../Configuration.md) section for details on the common device service configuration. 9 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-rest/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device REST - Purpose 3 | --- 4 | 5 | # Device REST - Purpose 6 | 7 | The purpose of the service is to provide an ingress point for REST base devices. 8 | REST base devices can send async data to this service using the REST API described in the [API Reference](./ApiReference.md) 9 | or respond to Get/Set [Device Commands](../../details/DeviceCommands.md). 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-rest/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device REST - Source Code 3 | --- 4 | 5 | # Device REST - Source Code 6 | 7 | The source code for Device REST can be found at [https://github.com/edgexfoundry/device-rest-go/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-rest-go/tree/{{edgexversion}}). 8 | 9 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-rfid-llrp.md: -------------------------------------------------------------------------------- 1 | # Device RFID LLRP 2 | 3 | Device service for communicating with LLRP-based RFID readers. 4 | 5 | See [README](https://github.com/edgexfoundry/device-rfid-llrp-go/tree/{{edgexversion}}#readme) for more details -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/ApiReference.md: -------------------------------------------------------------------------------- 1 | # Device S7 - API Reference 2 | 3 | This service inherits the [Common Device Service APIs](../../ApiReference.md) APIs from the SDK. 4 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/Configuration.md: -------------------------------------------------------------------------------- 1 | # Device S7 - Configuration 2 | 3 | This service does not have addition configuration to that provided by the Device SDK. 4 | See [Device Service Configuration](../../Configuration.md) section for details on the common device service configuration. 5 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/ProtocolProperties.md: -------------------------------------------------------------------------------- 1 | # Device S7 - Protocol Properties 2 | 3 | Device S7 defines the following Protocol Properties for ISO-on-TCP. 4 | 5 | These properties reside under the `s7` key in the protocols section of each device definition. 6 | 7 | | Properity | Default value | Note | 8 | | ----------- | ------------- | ----------------------------------- | 9 | | Host | N/A | S7 ip address, e.g. 192.168.123.199 | 10 | | Port | N/A | S7 port, e.g. 102 | 11 | | Rack | N/A | Rack number, e.g. 0 | 12 | | Slot | N/A | Slot number, e.g. 1 | 13 | | Timeout | 30 | connect to S7 timeout, seconds | 14 | | IdleTimeout | 30 | connection idle timeout, seconds | 15 | 16 | !!! example "Example S7 Protocol Properties" 17 | ```json 18 | ... 19 | "protocols": { 20 | "s7": { 21 | "Host": "192.168.123.199", 22 | "Port": 102, 23 | "Rack": 0, 24 | "Slot": 1, 25 | "Timeout": 30, 26 | "IdleTimeout": 30 27 | } 28 | } 29 | ... 30 | ``` 31 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/Purpose.md: -------------------------------------------------------------------------------- 1 | # Purpose 2 | 3 | The purpose of the service is to connect Siemens S7 PLC devices to EdgeX. -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/SourceCode.md: -------------------------------------------------------------------------------- 1 | # Device S7 - Source Code 2 | 3 | The source code for Device S7 can be found at [https://github.com/edgexfoundry/device-s7/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-s7/tree/{{edgexversion}}). 4 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/details/s7_data_type_conersion_read.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-s7/details/s7_data_type_conersion_read.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/details/s7_data_type_conersion_write.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-s7/details/s7_data_type_conersion_write.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/s7_communication_limitation.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-s7/s7_communication_limitation.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/s7_data_block_1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-s7/s7_data_block_1.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/s7_data_block_4.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-s7/s7_data_block_4.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/s7_enable_s7_communication.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-s7/s7_enable_s7_communication.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-s7/s7_ip_address.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-s7/s7_ip_address.jpg -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-snmp.md: -------------------------------------------------------------------------------- 1 | # Device SNMP 2 | 3 | Device service for SNMP protocol 4 | 5 | See [README](https://github.com/edgexfoundry/device-snmp-go/tree/{{edgexversion}}#readme) for more details -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-uart/APIReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device UART - API Reference 3 | --- 4 | 5 | # Device UART - API Reference 6 | 7 | Device UART inherits its REST APIs from the [Device Services SDK](../../ApiReference.md). -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-uart/Configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device UART - Configuration 3 | --- 4 | 5 | # Device UART - Configuration 6 | 7 | Device UART inherits its configuration from the [Device SDK Configuration](../../Configuration.md). -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-uart/GettingStarted.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device UART - Getting Started 3 | --- 4 | 5 | # Device UART - Getting Started 6 | 7 | ## Overview 8 | 9 | Device UART is a device service for connecting a UART serial device to EdgeX using the EdgeX Message Bus. 10 | 11 | ## Running Services with Device UART 12 | 13 | The simplest way to run all the required services is to use the [Compose Builder](https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}/compose-builder) tool from a terminal window. 14 | 15 | 1. Clone [https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}](https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}) 16 | 17 | 2. Change to the **compose-builder** folder 18 | 19 | 3. Run the services 20 | ``` 21 | make run ds-uart no-secty 22 | ``` 23 | This runs, in non-secure mode, all the standard EdgeX services and the UART device service. -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-uart/ProtocolProperties.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device UART - Protocol Properties 3 | --- 4 | 5 | # Device UART - Protocol Properties 6 | 7 | This service defines the following Protocol Properties for each defined UART device. These properties reside under the `UART` key in the `protocols` section of each device definition. 8 | 9 | | Property | Description | 10 | |----------------|--------------------------------------------------------------------------| 11 | | deviceLocation | Linux path to the device | 12 | | baudRate | Rate information is transferred (bits/second) | 13 | 14 | !!! example - "Example UART Protocol Properties" 15 | 16 | ```yaml 17 | protocols: 18 | UART: 19 | deviceLocation: "/dev/ttyAMA2" 20 | baudRate: 115200 21 | ``` -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-uart/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device UART - Purpose 3 | --- 4 | 5 | # Device UART - Purpose 6 | 7 | The Device UART Microservice is a device service used for connecting serial UART devices/sensors to EdgeX. This device service implements communication with universal serial devices such as USB to TTL serial, rs232, or rs485 interface device for reading and setting values. The values read are published to the EdgeX Message Bus; the values set are received from other EdgeX services. This device service **ONLY** works on **Linux** systems. This device service is contributed by [Jiangxing Intelligence](https://www.jiangxingai.com/) and HCL Technologies (EPL Team). -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-uart/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Device UART - Source Code 3 | --- 4 | 5 | # Device UART - Source Code 6 | 7 | The source code for Device UART can be found at [https://github.com/edgexfoundry/device-uart/tree/{{edgexversion}}](https://github.com/edgexfoundry/device-uart/tree/{{edgexversion}}). -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-usb-camera/images/USBDeviceServiceArch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-usb-camera/images/USBDeviceServiceArch.png -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-usb-camera/supplementary-info/USB-protocol.md: -------------------------------------------------------------------------------- 1 | # USB Camera Device Service Specifications 2 | 3 | ## USB Protocol Properties 4 | | Property | Description | EdgeX Value Type | 5 | | -- | -- | | 6 | | **Path** | Specifies the internal [/dev/video path](https://www.kernel.org/doc/html/v4.9/media/uapi/v4l/dev-capture.html) for the camera device. **DEPRECATED: Path will be removed in the next major release, use Paths**. | String | 7 | | **Paths** | A list of internal [/dev/video paths](https://www.kernel.org/doc/html/v4.9/media/uapi/v4l/dev-capture.html) for the camera device. This list includes all streaming capable video paths for each device. | Object | 8 | | **SerialNumber** | The serial number of the camera device. | String | 9 | | **CardName** | The manufacturer specified name of the camera device. | String | 10 | | **AutoStreaming** | A value indicating if the device should automatically start streaming. | String | 11 | -------------------------------------------------------------------------------- /docs_src/microservices/device/services/device-virtual/EdgeX_VirtualDevice.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/device/services/device-virtual/EdgeX_VirtualDevice.png -------------------------------------------------------------------------------- /docs_src/microservices/general/MultipleInstances.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/general/MultipleInstances.png -------------------------------------------------------------------------------- /docs_src/microservices/general/messagebus diagram.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/general/messagebus diagram.jpg -------------------------------------------------------------------------------- /docs_src/microservices/support/EdgeX_SupportingServices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/EdgeX_SupportingServices.png -------------------------------------------------------------------------------- /docs_src/microservices/support/eKuiper/EdgeX_eKuiperRulesEngine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/eKuiper/EdgeX_eKuiperRulesEngine.png -------------------------------------------------------------------------------- /docs_src/microservices/support/eKuiper/arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/eKuiper/arch.png -------------------------------------------------------------------------------- /docs_src/microservices/support/eKuiper/arch_light.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/eKuiper/arch_light.png -------------------------------------------------------------------------------- /docs_src/microservices/support/notifications/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Support Notification - API Reference 3 | --- 4 | 5 | # Support Notifications - API Reference 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs_src/microservices/support/notifications/EdgeX_SupportingServicesAlertsArchitecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/notifications/EdgeX_SupportingServicesAlertsArchitecture.png -------------------------------------------------------------------------------- /docs_src/microservices/support/notifications/EdgeX_SupportingServicesAlertsNotifications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/notifications/EdgeX_SupportingServicesAlertsNotifications.png -------------------------------------------------------------------------------- /docs_src/microservices/support/notifications/EdgeX_SupportingServicesNotificationsModel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/notifications/EdgeX_SupportingServicesNotificationsModel.png -------------------------------------------------------------------------------- /docs_src/microservices/support/notifications/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Support Notification - Purpose 3 | --- 4 | 5 | # Support Notifications - Purpose 6 | 7 | ![image](EdgeX_SupportingServicesAlertsNotifications.png) 8 | 9 | When another system or a person needs to know that something occurred in EdgeX, the 10 | alerts and notifications microservice sends that notification. 11 | Examples of alerts and notifications that other services could broadcast include the provisioning of a new device, abnormal sensor data detected 12 | (usually detected by a device service or rules engine), or system or service 13 | malfunctions (usually detected by system management services). -------------------------------------------------------------------------------- /docs_src/microservices/support/notifications/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Support Notification - Source Code 3 | --- 4 | 5 | # Support Notification - Source Code 6 | 7 | The source code for Supporting Notifications and Alerts can be found within edgex-go at [https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/support-notifications](https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/support-notifications). -------------------------------------------------------------------------------- /docs_src/microservices/support/notifications/details/DataRetention.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Support Notification - Data Retention and Persistent Caps 3 | --- 4 | 5 | # Support Notification - Data Retention and Persistent Caps 6 | 7 | ## Introduction 8 | 9 | Support Notifications service shares the same feature as core data, which is the ability of persisting the latest recent readings only and cleaning up the old ones. For detailed information on the data retention see [Use Case for capping readings in Core Data](../../../../design/ucr/Core-Data-Retention.md) and [Introduction for for capping readings in Core Data](../../../core/data/details/DataRetention.md#overview). -------------------------------------------------------------------------------- /docs_src/microservices/support/scheduler/ApiReference.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Support Scheduler - API Reference 3 | --- 4 | 5 | # Support Scheduler - API Reference 6 | 7 | 8 | EdgeX Foundry's Support Scheduler microservice schedules actions to occur on specific intervals or a crontab expression scheduled time 9 | 10 | -------------------------------------------------------------------------------- /docs_src/microservices/support/scheduler/EdgeX_SupportingServicesScheduling.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/microservices/support/scheduler/EdgeX_SupportingServicesScheduling.png -------------------------------------------------------------------------------- /docs_src/microservices/support/scheduler/Purpose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Support Scheduler - Purpose 3 | --- 4 | 5 | # Support Scheduler - Purpose 6 | 7 | ![image](EdgeX_SupportingServicesScheduling.png) 8 | 9 | The Support Scheduler microservice provides a mechanism that can kick off operations in any EdgeX service. 10 | 11 | At a configuration specified time or a crontab expression scheduled time, the service calls on any EdgeX service via REST, EdgeX Message Bus, or Device Control to trigger an operation. 12 | 13 | A schedule action record will be created for each operation. 14 | 15 | For example, the scheduler service periodically calls on core data APIs to clean up old sensed events that have been successfully exported out of EdgeX. 16 | -------------------------------------------------------------------------------- /docs_src/microservices/support/scheduler/SourceCode.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Support Scheduler - Source Code 3 | --- 4 | 5 | # Support Scheduler - Source Code 6 | 7 | The source code for Support Scheduler can be found within edgex-go at [https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/support-scheduler](https://github.com/edgexfoundry/edgex-go/tree/{{edgexversion}}/cmd/support-scheduler). -------------------------------------------------------------------------------- /docs_src/run.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/run.png -------------------------------------------------------------------------------- /docs_src/security/.gitignore: -------------------------------------------------------------------------------- 1 | #placeholder 2 | -------------------------------------------------------------------------------- /docs_src/security/Ch-Secure-MessageBus.md: -------------------------------------------------------------------------------- 1 | # Secure MessageBus 2 | 3 | All the default services (Core Data, App Service Rules, Device Virtual, eKuiper, etc.) that utilize the `MessageBus` are configured out of the box to connect securely. 4 | 5 | Additional add-on services that require `Secure MessageBus` access (App and/or Device services) need to follow the steps outline in the [Configuring Add-On Services for Security](Ch-Configuring-Add-On-Services.md) section. 6 | 7 | -------------------------------------------------------------------------------- /docs_src/security/EdgeX_Security.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/security/EdgeX_Security.png -------------------------------------------------------------------------------- /docs_src/security/authentication-network.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/security/authentication-network.jpg -------------------------------------------------------------------------------- /docs_src/security/consul-login-input.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/security/consul-login-input.png -------------------------------------------------------------------------------- /docs_src/security/consul-login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/security/consul-login.png -------------------------------------------------------------------------------- /docs_src/security/secrets-config.md: -------------------------------------------------------------------------------- 1 | % edgex-secrets-config(1) User Manuals edgex-secrets-config(1) 2 | 3 | # NAME 4 | 5 | **edgex-secrets-config** – Perform post-installation EdgeX secrets configuration 6 | 7 | # SYNOPSIS 8 | 9 | **edgex-secrets-config** [OPTIONS] COMMAND [ARG...] 10 | 11 | # DESCRIPTION 12 | 13 | **edgex-secrets-config** performs post-installation EdgeX secrets configuration. edgex-secrets-config takes a command that specifies which module is being configured, and module-specific arguments thereafter. 14 | 15 | # COMMANDS 16 | 17 | * **help** 18 | 19 | Return a list of available commands. Use `edgex-secrets-config help (command)` for an overview of available subcommands. 20 | 21 | * **proxy** 22 | 23 | Configure secrets related to the EdgeX reverse proxy. Use `edgex-secrets-config help proxy` for an overview of available subcommands. 24 | 25 | # SEE ALSO 26 | 27 | edgex-secrets-config-proxy(1) 28 | 29 | EdgeX Foundry Last change: 2021 -------------------------------------------------------------------------------- /docs_src/sensor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/sensor.png -------------------------------------------------------------------------------- /docs_src/snap.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/snap.png -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/README.md: -------------------------------------------------------------------------------- 1 | # EdgeX Foundry Secret Management Threat Model 2 | 3 | ## Table of Contents 4 | 5 | 1. [Background](background.md) 6 | 2. [High Level Design](high_level_design.md) 7 | 3. [Threat Model](threat_model.md) 8 | 4. [Vault Master Key Encryption](vault_master_key_encryption.md) -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/arch-as-is.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/arch-as-is.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/arch-in-context.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/arch-in-context.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/arch-proposed.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/arch-proposed.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/general_requirements.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/general_requirements.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/high_level_architecture.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/high_level_architecture.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/pki_initialization.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/pki_initialization.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/token_handshake.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/token_handshake.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/secret-store/vault_initialization.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/secret-store/vault_initialization.jpg -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/000754c9748372ccedffc49501de21ef3f190834.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/000754c9748372ccedffc49501de21ef3f190834.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/1dd5023016ec714c4a35acbca5f864d470066513.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/1dd5023016ec714c4a35acbca5f864d470066513.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/1f292f1a3d48be04ffe8699cdd4fce3d5ce26378.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/1f292f1a3d48be04ffe8699cdd4fce3d5ce26378.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/27aff3dc2f3be34f14c9df98144e45253ab5a3f2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/27aff3dc2f3be34f14c9df98144e45253ab5a3f2.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/370d40538ed437868c549d375c80fc346bb74d78.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/370d40538ed437868c549d375c80fc346bb74d78.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/37e3359d25fa97249ccb455d02d007c38c2c5ee6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/37e3359d25fa97249ccb455d02d007c38c2c5ee6.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/452c630b73ccf9644f721b0e1996d525ca23e7c3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/452c630b73ccf9644f721b0e1996d525ca23e7c3.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/51fd5bb8dbafb70a81ea944df00bafd09f572145.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/51fd5bb8dbafb70a81ea944df00bafd09f572145.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/58a5dfd01d7bfd7e696b1eb90413109b63015f24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/58a5dfd01d7bfd7e696b1eb90413109b63015f24.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/5b6b1393903b5dbab7dc230af2a390c29ecc10de.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/5b6b1393903b5dbab7dc230af2a390c29ecc10de.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/5be215f86d45911102a7f04833341d1daeefa06a.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/5be215f86d45911102a7f04833341d1daeefa06a.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/7b330b153ded5645477e4aab00a47fc72df84540.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/7b330b153ded5645477e4aab00a47fc72df84540.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/83291d39671446a08d933ebb79fe3dfc6c83397f.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/83291d39671446a08d933ebb79fe3dfc6c83397f.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/93d4c0008d705bc3a754f06ab674dfd81f209cb8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/93d4c0008d705bc3a754f06ab674dfd81f209cb8.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/982310eb4e8fc122b54a0d765674cd5eab0ac7e1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/982310eb4e8fc122b54a0d765674cd5eab0ac7e1.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/9903754dc4447477796031724a9061ae28da9774.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/9903754dc4447477796031724a9061ae28da9774.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/9ab35f47ac55cc1aaf2ad660f5b1460490d8c6d3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/9ab35f47ac55cc1aaf2ad660f5b1460490d8c6d3.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/9cb564f532d6ff91c53ea79ecf1ad9ed5faf8700.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/9cb564f532d6ff91c53ea79ecf1ad9ed5faf8700.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/9fec79313ae64a7598250237fcd77f4313fb9050.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/9fec79313ae64a7598250237fcd77f4313fb9050.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/a4fd191dbdf6414eba87d73172e82ae4c2aa1ca0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/a4fd191dbdf6414eba87d73172e82ae4c2aa1ca0.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/aa69f547ac6a70d383c2ebd8e25a46a5ecdc92d4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/aa69f547ac6a70d383c2ebd8e25a46a5ecdc92d4.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/aac9c8f8a15a73056a1aeb22f018c9f4adfeb82c.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/aac9c8f8a15a73056a1aeb22f018c9f4adfeb82c.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/c7507325cde7578f40b525bd350167e26dbc156d.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/c7507325cde7578f40b525bd350167e26dbc156d.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/d234fbeac22fb73adf69619f8ad2021fc366eee4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/d234fbeac22fb73adf69619f8ad2021fc366eee4.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/d3995a698c2088f95d0c475b00f6be8d7e5fa92f.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/d3995a698c2088f95d0c475b00f6be8d7e5fa92f.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/d5a51b38fede063079dfcd0b09d519f82b5fc397.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/d5a51b38fede063079dfcd0b09d519f82b5fc397.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/d5c5f624f27b635fb01afcba1ccf2cf6a0054468.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/d5c5f624f27b635fb01afcba1ccf2cf6a0054468.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/d5f2a45878bc7b3c416a69b2241f085e2d683149.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/d5f2a45878bc7b3c416a69b2241f085e2d683149.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/d840bf18c36361a6cf0c76f061343f008b58aca0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/d840bf18c36361a6cf0c76f061343f008b58aca0.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/ddca459de99927ac2cade07d1bf2643b16073bdf.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/ddca459de99927ac2cade07d1bf2643b16073bdf.png -------------------------------------------------------------------------------- /docs_src/threat-models/stride-model/images/ffee1c08d6afa3f01c1780fbd66ee34aa1e1223c.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/threat-models/stride-model/images/ffee1c08d6afa3f01c1780fbd66ee34aa1e1223c.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughAppServiceLog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughAppServiceLog.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughCameraCommands.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughCameraCommands.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughConsulKeyValue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughConsulKeyValue.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughConsulSetLogLevel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughConsulSetLogLevel.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughCurlPOST_Response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughCurlPOST_Response.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughDeployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughDeployment.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughGetCommands.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughGetCommands.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughGetCommands_Curl.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughGetCommands_Curl.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughHumansCanine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughHumansCanine.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughPostValueDescriptor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughPostValueDescriptor.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughPostmanFile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughPostmanFile.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughPostmanHeaders.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughPostmanHeaders.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughPostmanPOST.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughPostmanPOST.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughPostmanPOST_Response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughPostmanPOST_Response.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughPutCommandURL.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughPutCommandURL.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughSendEvent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughSendEvent.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughSendEvent_Curl.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughSendEvent_Curl.png -------------------------------------------------------------------------------- /docs_src/walk-through/EdgeX_WalkthroughSnapshotDepth.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edgexfoundry/edgex-docs/4ddf16fd9706555566547578668707cc22f0bd75/docs_src/walk-through/EdgeX_WalkthroughSnapshotDepth.png -------------------------------------------------------------------------------- /template_macros.yaml: -------------------------------------------------------------------------------- 1 | # version is the git branch or tag 2 | # 3 | # Its value is used in Github URLs 4 | # 5 | # In the main branch, it should always be set to "main". 6 | # Upon releases and in edgex-docs release branches (e.g. levski, minnesota), 7 | # the value should be replaced with the git tag that is the minor semantic 8 | # version. 9 | # 10 | # Examples: main, v3.0, v3.1 11 | edgexversion: main 12 | config_version: v4 13 | # api_version is the major API version 14 | # 15 | # Examples: v2, v3 16 | api_version: v3 --------------------------------------------------------------------------------