setup a GP Joule app

eliona-smart-building-assistant · Feb 22, 2024 · 5f7faeb · 5f7faeb
1 parent 4827a50
commit 5f7faeb
Show file tree

Hide file tree

Showing 42 changed files with 160 additions and 156 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -24,7 +24,7 @@ RUN go mod download
 
 RUN DATE=$(date) && \
     GIT_COMMIT=$(git rev-list -1 HEAD) && \
-    go build -ldflags "-X 'template/apiservices.BuildTimestamp=$DATE' -X 'template/apiservices.GitCommit=$GIT_COMMIT'" -o ../app
+    go build -ldflags "-X 'gp-joule/apiservices.BuildTimestamp=$DATE' -X 'gp-joule/apiservices.GitCommit=$GIT_COMMIT'" -o ../app
 
 FROM eliona/base-alpine:latest AS target
 

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Leicom ITEC AG
+Copyright (c) 2024 Leicom ITEC AG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# App Template
+# Eliona App for GP Joule
 
-This template is a part of the Eliona App SDK. It can be used to create an app stub for an Eliona environment.
+This app connects [GP Joule API](https://www.gp-joule.com/) and gathers information about data of charging stations.
 
 ## Configuration
 
@@ -34,11 +34,11 @@ This initialization can be handled by the `reset.sql` script.
 
 <mark>Todo: Describe other tables if the app needs them.</mark>
 
-The app requires configuration data that remains in the database. To do this, the app creates its own database schema `template` during initialization. To modify and handle the configuration data the app provides an API access. Have a look at the [API specification](https://eliona-smart-building-assistant.github.io/open-api-docs/?https://raw.githubusercontent.com/eliona-smart-building-assistant/app-template/develop/openapi.yaml) how the configuration tables should be used.
+The app requires configuration data that remains in the database. To do this, the app creates its own database schema `gp_joule` during initialization. To modify and handle the configuration data the app provides an API access. Have a look at the [API specification](https://eliona-smart-building-assistant.github.io/open-api-docs/?https://raw.githubusercontent.com/eliona-smart-building-assistant/gp-joule-app/develop/openapi.yaml) how the configuration tables should be used.
 
-- `template.configuration`: Contains configuration of the app. Editable through the API.
+- `gp_joule.configuration`: Contains configuration of the app. Editable through the API.
 
-- `template.asset`: Provides asset mapping. Maps broker's asset IDs to Eliona asset IDs.
+- `gp_joule.asset`: Provides asset mapping. Maps broker's asset IDs to Eliona asset IDs.
 
 **Generation**: to generate access method to database see Generation section below.
 
@@ -49,7 +49,7 @@ The app requires configuration data that remains in the database. To do this, th
 
 The app provides its own API to access configuration data and other functions. The full description of the API is defined in the `openapi.yaml` OpenAPI definition file.
 
-- [API Reference](https://eliona-smart-building-assistant.github.io/open-api-docs/?https://raw.githubusercontent.com/eliona-smart-building-assistant/app-template/develop/openapi.yaml) shows details of the API
+- [API Reference](https://eliona-smart-building-assistant.github.io/open-api-docs/?https://raw.githubusercontent.com/eliona-smart-building-assistant/gp-joule-app/develop/openapi.yaml) shows details of the API
 
 **Generation**: to generate api server stub see Generation section below.
 
@@ -67,7 +67,7 @@ The data is written for each device, structured into different subtypes of Elino
 
 ### Continuous asset creation ###
 
-Assets for all devices connected to the Template account are created automatically when the configuration is added.
+Assets for all devices connected to the GP Joule API are created automatically when a configuration is added.
 
 To select which assets to create, a filter could be specified in config. The schema of the filter is defined in the `openapi.yaml` file.
 

diff --git a/apiserver/api.go b/apiserver/api.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/api_configuration.go b/apiserver/api_configuration.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/api_customization.go b/apiserver/api_customization.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/api_version.go b/apiserver/api_version.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/error.go b/apiserver/error.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/helpers.go b/apiserver/helpers.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/impl.go b/apiserver/impl.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/logger.go b/apiserver/logger.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/model_configuration.go b/apiserver/model_configuration.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/model_dashboard.go b/apiserver/model_dashboard.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/model_filter_rule.go b/apiserver/model_filter_rule.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/model_widget.go b/apiserver/model_widget.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/model_widget_data.go b/apiserver/model_widget_data.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiserver/routers.go b/apiserver/routers.go
@@ -1,7 +1,7 @@
 /*
- * App template API
+ * GP Joule app API
  *
- * API to access and configure the app template
+ * API to access and configure the GP Joule app
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/apiservices/api_configuration_service.go b/apiservices/api_configuration_service.go
@@ -18,9 +18,9 @@ package apiservices
 import (
 	"context"
 	"errors"
+	"gp-joule/apiserver"
+	"gp-joule/conf"
 	"net/http"
-	"template/apiserver"
-	"template/conf"
 )
 
 // ConfigurationAPIService is a service that implements the logic for the ConfigurationAPIServicer

diff --git a/apiservices/api_customization_service.go b/apiservices/api_customization_service.go
@@ -17,8 +17,8 @@ package apiservices
 
 import (
 	"context"
+	"gp-joule/apiserver"
 	"net/http"
-	"template/apiserver"
 )
 
 // CustomizationAPIService is a service that implements the logic for the CustomizationAPIServicer
@@ -34,7 +34,7 @@ func NewCustomizationAPIService() apiserver.CustomizationAPIServicer {
 
 // GetDashboardTemplateByName - Get a full dashboard template
 func (s *CustomizationAPIService) GetDashboardTemplateByName(ctx context.Context, dashboardTemplateName string, projectId string) (apiserver.ImplResponse, error) {
-	if dashboardTemplateName == "Template" {
+	if dashboardTemplateName == "GP Joule" {
 		return apiserver.ImplResponse{Code: http.StatusNotImplemented}, nil
 	} else {
 		return apiserver.ImplResponse{Code: http.StatusNotFound}, nil

diff --git a/apiservices/api_version_service.go b/apiservices/api_version_service.go
@@ -18,10 +18,10 @@ package apiservices
 import (
 	"context"
 	"encoding/json"
+	"gp-joule/apiserver"
 	"io"
 	"net/http"
 	"os"
-	"template/apiserver"
 
 	"github.com/eliona-smart-building-assistant/go-utils/common"
 	"github.com/eliona-smart-building-assistant/go-utils/log"

diff --git a/app.go b/app.go
@@ -17,13 +17,13 @@ package main
 
 import (
 	"context"
+	"gp-joule/apiserver"
+	"gp-joule/apiservices"
+	"gp-joule/appdb"
+	"gp-joule/conf"
+	"gp-joule/eliona"
 	"net/http"
 	"sync"
-	"template/apiserver"
-	"template/apiservices"
-	"template/appdb"
-	"template/conf"
-	"template/eliona"
 	"time"
 
 	"github.com/eliona-smart-building-assistant/go-eliona/app"