From f0f9030e2872e3289c5659d11294bad6bea8bef9 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Thu, 20 Nov 2025 15:48:05 +0100 Subject: [PATCH 01/14] brick - add require on list and details --- internal/orchestrator/bricks/bricks.go | 39 +++++++++++-------- internal/orchestrator/bricks/types.go | 15 ++++--- .../orchestrator/bricksindex/bricks_index.go | 1 + 3 files changed, 32 insertions(+), 23 deletions(-) diff --git a/internal/orchestrator/bricks/bricks.go b/internal/orchestrator/bricks/bricks.go index 3b722b3d3..cef2c3088 100644 --- a/internal/orchestrator/bricks/bricks.go +++ b/internal/orchestrator/bricks/bricks.go @@ -58,12 +58,16 @@ func (s *Service) List() (BrickListResult, error) { res := BrickListResult{Bricks: make([]BrickListItem, len(s.bricksIndex.Bricks))} for i, brick := range s.bricksIndex.Bricks { res.Bricks[i] = BrickListItem{ - ID: brick.ID, - Name: brick.Name, - Author: "Arduino", // TODO: for now we only support our bricks - Description: brick.Description, - Category: brick.Category, - Status: "installed", + ID: brick.ID, + Name: brick.Name, + Author: "Arduino", // TODO: for now we only support our bricks + Description: brick.Description, + Category: brick.Category, + Status: "installed", + ModelRequired: brick.ModelRequired, + Models: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) string { + return m.ID + }), } } return res, nil @@ -198,17 +202,18 @@ func (s *Service) BricksDetails(id string, idProvider *app.IDProvider, return BrickDetailsResult{}, fmt.Errorf("unable to get used by apps: %w", err) } return BrickDetailsResult{ - ID: id, - Name: brick.Name, - Author: "Arduino", // TODO: for now we only support our bricks - Description: brick.Description, - Category: brick.Category, - Status: "installed", // For now every Arduino brick are installed - Variables: variables, - Readme: readme, - ApiDocsPath: apiDocsPath, - CodeExamples: codeExamples, - UsedByApps: usedByApps, + ID: id, + Name: brick.Name, + Author: "Arduino", // TODO: for now we only support our bricks + Description: brick.Description, + Category: brick.Category, + ModelRequired: brick.ModelRequired, + Status: "installed", // For now every Arduino brick are installed + Variables: variables, + Readme: readme, + ApiDocsPath: apiDocsPath, + CodeExamples: codeExamples, + UsedByApps: usedByApps, CompatibleModels: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) AIModel { return AIModel{ ID: m.ID, diff --git a/internal/orchestrator/bricks/types.go b/internal/orchestrator/bricks/types.go index 782ec2f23..0854fac7d 100644 --- a/internal/orchestrator/bricks/types.go +++ b/internal/orchestrator/bricks/types.go @@ -20,12 +20,14 @@ type BrickListResult struct { } type BrickListItem struct { - ID string `json:"id"` - Name string `json:"name"` - Author string `json:"author"` - Description string `json:"description"` - Category string `json:"category"` - Status string `json:"status"` + ID string `json:"id"` + Name string `json:"name"` + Author string `json:"author"` + Description string `json:"description"` + Category string `json:"category"` + Status string `json:"status"` + ModelRequired bool `json:"model_required"` + Models []string `json:"models"` } type AppBrickInstancesResult struct { @@ -78,6 +80,7 @@ type BrickDetailsResult struct { Description string `json:"description"` Category string `json:"category"` Status string `json:"status"` + ModelRequired bool `json:"model_required"` Variables map[string]BrickVariable `json:"variables,omitempty"` Readme string `json:"readme"` ApiDocsPath string `json:"api_docs_path"` diff --git a/internal/orchestrator/bricksindex/bricks_index.go b/internal/orchestrator/bricksindex/bricks_index.go index e4b774f47..ec0a71164 100644 --- a/internal/orchestrator/bricksindex/bricks_index.go +++ b/internal/orchestrator/bricksindex/bricks_index.go @@ -58,6 +58,7 @@ type Brick struct { RequireModel bool `yaml:"require_model"` Variables []BrickVariable `yaml:"variables,omitempty"` Ports []string `yaml:"ports,omitempty"` + ModelRequired bool `yaml:"model_required,omitempty"` ModelName string `yaml:"model_name,omitempty"` MountDevicesIntoContainer bool `yaml:"mount_devices_into_container,omitempty"` RequiredDevices []string `yaml:"required_devices,omitempty"` From a2039cf261600babb7482aead487497d2e36c373 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Thu, 20 Nov 2025 16:39:57 +0100 Subject: [PATCH 02/14] require_model for the app bricks --- internal/orchestrator/bricks/bricks.go | 1 + internal/orchestrator/bricks/types.go | 1 + internal/orchestrator/orchestrator.go | 8 +++++--- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/internal/orchestrator/bricks/bricks.go b/internal/orchestrator/bricks/bricks.go index cef2c3088..2490ca361 100644 --- a/internal/orchestrator/bricks/bricks.go +++ b/internal/orchestrator/bricks/bricks.go @@ -89,6 +89,7 @@ func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesRes Author: "Arduino", // TODO: for now we only support our bricks Category: brick.Category, Status: "installed", + ModelRequired: brick.ModelRequired, ModelID: brickInstance.Model, // TODO: in case is not set by the user, should we return the default model? Variables: variablesMap, // TODO: do we want to show also the default value of not explicitly set variables? ConfigVariables: configVariables, diff --git a/internal/orchestrator/bricks/types.go b/internal/orchestrator/bricks/types.go index 0854fac7d..d30c2de93 100644 --- a/internal/orchestrator/bricks/types.go +++ b/internal/orchestrator/bricks/types.go @@ -42,6 +42,7 @@ type BrickInstance struct { Status string `json:"status"` Variables map[string]string `json:"variables,omitempty" description:"Deprecated: use config_variables instead. This field is kept for backward compatibility."` ConfigVariables []BrickConfigVariable `json:"config_variables,omitempty"` + ModelRequired bool `json:"model_required,omitempty"` ModelID string `json:"model,omitempty"` CompatibleModels []AIModel `json:"compatible_models"` } diff --git a/internal/orchestrator/orchestrator.go b/internal/orchestrator/orchestrator.go index 8eedff6f1..58f16dfde 100644 --- a/internal/orchestrator/orchestrator.go +++ b/internal/orchestrator/orchestrator.go @@ -673,9 +673,10 @@ type AppDetailedInfo struct { } type AppDetailedBrick struct { - ID string `json:"id" required:"true"` - Name string `json:"name" required:"true"` - Category string `json:"category,omitempty"` + ID string `json:"id" required:"true"` + Name string `json:"name" required:"true"` + Category string `json:"category,omitempty"` + ModelRequired bool `json:"model_required,omitempty"` } func AppDetails( @@ -738,6 +739,7 @@ func AppDetails( } res.Name = bi.Name res.Category = bi.Category + res.ModelRequired = bi.ModelRequired return res }), }, nil From 92b24b0e95b4001d08257412e31a3bef5bdf00af Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Thu, 20 Nov 2025 17:19:20 +0100 Subject: [PATCH 03/14] fixing yaml ser --- internal/orchestrator/bricks/bricks.go | 2 +- internal/orchestrator/bricks/types.go | 6 +++--- internal/orchestrator/bricksindex/bricks_index.go | 3 +-- internal/orchestrator/bricksindex/bricks_index_test.go | 2 +- internal/orchestrator/orchestrator.go | 2 +- 5 files changed, 7 insertions(+), 8 deletions(-) diff --git a/internal/orchestrator/bricks/bricks.go b/internal/orchestrator/bricks/bricks.go index 2490ca361..38914420b 100644 --- a/internal/orchestrator/bricks/bricks.go +++ b/internal/orchestrator/bricks/bricks.go @@ -89,7 +89,7 @@ func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesRes Author: "Arduino", // TODO: for now we only support our bricks Category: brick.Category, Status: "installed", - ModelRequired: brick.ModelRequired, + ModelRequired: brick.ModelRequired, // TODO: in case is not set by the user, should we return false? ModelID: brickInstance.Model, // TODO: in case is not set by the user, should we return the default model? Variables: variablesMap, // TODO: do we want to show also the default value of not explicitly set variables? ConfigVariables: configVariables, diff --git a/internal/orchestrator/bricks/types.go b/internal/orchestrator/bricks/types.go index d30c2de93..3290e72c4 100644 --- a/internal/orchestrator/bricks/types.go +++ b/internal/orchestrator/bricks/types.go @@ -26,7 +26,7 @@ type BrickListItem struct { Description string `json:"description"` Category string `json:"category"` Status string `json:"status"` - ModelRequired bool `json:"model_required"` + ModelRequired bool `json:"require_model"` Models []string `json:"models"` } @@ -42,7 +42,7 @@ type BrickInstance struct { Status string `json:"status"` Variables map[string]string `json:"variables,omitempty" description:"Deprecated: use config_variables instead. This field is kept for backward compatibility."` ConfigVariables []BrickConfigVariable `json:"config_variables,omitempty"` - ModelRequired bool `json:"model_required,omitempty"` + ModelRequired bool `json:"require_model,omitempty"` ModelID string `json:"model,omitempty"` CompatibleModels []AIModel `json:"compatible_models"` } @@ -81,7 +81,7 @@ type BrickDetailsResult struct { Description string `json:"description"` Category string `json:"category"` Status string `json:"status"` - ModelRequired bool `json:"model_required"` + ModelRequired bool `json:"require_model"` Variables map[string]BrickVariable `json:"variables,omitempty"` Readme string `json:"readme"` ApiDocsPath string `json:"api_docs_path"` diff --git a/internal/orchestrator/bricksindex/bricks_index.go b/internal/orchestrator/bricksindex/bricks_index.go index ec0a71164..5d2ca15c9 100644 --- a/internal/orchestrator/bricksindex/bricks_index.go +++ b/internal/orchestrator/bricksindex/bricks_index.go @@ -55,10 +55,9 @@ type Brick struct { Category string `yaml:"category,omitempty"` RequiresDisplay string `yaml:"requires_display,omitempty"` RequireContainer bool `yaml:"require_container"` - RequireModel bool `yaml:"require_model"` Variables []BrickVariable `yaml:"variables,omitempty"` Ports []string `yaml:"ports,omitempty"` - ModelRequired bool `yaml:"model_required,omitempty"` + ModelRequired bool `yaml:"require_model,omitempty"` ModelName string `yaml:"model_name,omitempty"` MountDevicesIntoContainer bool `yaml:"mount_devices_into_container,omitempty"` RequiredDevices []string `yaml:"required_devices,omitempty"` diff --git a/internal/orchestrator/bricksindex/bricks_index_test.go b/internal/orchestrator/bricksindex/bricks_index_test.go index 5b2a15467..11b11631e 100644 --- a/internal/orchestrator/bricksindex/bricks_index_test.go +++ b/internal/orchestrator/bricksindex/bricks_index_test.go @@ -173,7 +173,7 @@ func TestBricksIndex(t *testing.T) { require.True(t, found) require.Equal(t, "Image Classification", b.Name) require.Equal(t, "mobilenet-image-classification", b.ModelName) - require.True(t, b.RequireModel) + require.True(t, b.ModelRequired) require.Len(t, b.Variables, 2) require.Equal(t, "CUSTOM_MODEL_PATH", b.Variables[0].Name) require.Equal(t, "/opt/models/ei/", b.Variables[0].DefaultValue) diff --git a/internal/orchestrator/orchestrator.go b/internal/orchestrator/orchestrator.go index 58f16dfde..e7265c36e 100644 --- a/internal/orchestrator/orchestrator.go +++ b/internal/orchestrator/orchestrator.go @@ -676,7 +676,7 @@ type AppDetailedBrick struct { ID string `json:"id" required:"true"` Name string `json:"name" required:"true"` Category string `json:"category,omitempty"` - ModelRequired bool `json:"model_required,omitempty"` + ModelRequired bool `json:"require_model,omitempty"` } func AppDetails( From e5d8882ae268c8b081530f92f4ee9350d340b20b Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Thu, 20 Nov 2025 17:31:05 +0100 Subject: [PATCH 04/14] list app brick detalis --- internal/orchestrator/bricks/bricks.go | 1 + 1 file changed, 1 insertion(+) diff --git a/internal/orchestrator/bricks/bricks.go b/internal/orchestrator/bricks/bricks.go index 38914420b..d71fc0618 100644 --- a/internal/orchestrator/bricks/bricks.go +++ b/internal/orchestrator/bricks/bricks.go @@ -123,6 +123,7 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br Author: "Arduino", // TODO: for now we only support our bricks Category: brick.Category, Status: "installed", // For now every Arduino brick are installed + ModelRequired: brick.ModelRequired, Variables: variables, ConfigVariables: configVariables, ModelID: modelID, From 5d361e89d94dcf39ba2d45fdba104ae48cf80354 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Fri, 21 Nov 2025 12:46:47 +0100 Subject: [PATCH 05/14] add tests on reqmodel --- internal/api/docs/openapi.yaml | 8 ++++ internal/e2e/client/client.gen.go | 23 ++++++---- internal/e2e/daemon/app_test.go | 7 +-- internal/e2e/daemon/brick_test.go | 1 + .../bricksindex/bricks_index_test.go | 45 ++++++++++++------- 5 files changed, 56 insertions(+), 28 deletions(-) diff --git a/internal/api/docs/openapi.yaml b/internal/api/docs/openapi.yaml index f50969e67..f32c9a769 100644 --- a/internal/api/docs/openapi.yaml +++ b/internal/api/docs/openapi.yaml @@ -1204,6 +1204,8 @@ components: type: string name: type: string + require_model: + type: boolean required: - id - name @@ -1332,6 +1334,8 @@ components: type: string readme: type: string + require_model: + type: boolean status: type: string used_by_apps: @@ -1365,6 +1369,8 @@ components: type: string name: type: string + require_model: + type: boolean status: type: string variables: @@ -1386,6 +1392,8 @@ components: type: string name: type: string + require_model: + type: boolean status: type: string type: object diff --git a/internal/e2e/client/client.gen.go b/internal/e2e/client/client.gen.go index 1f3e6bbd5..40d7b4960 100644 --- a/internal/e2e/client/client.gen.go +++ b/internal/e2e/client/client.gen.go @@ -71,9 +71,10 @@ type AppBrickInstancesResult struct { // AppDetailedBrick defines model for AppDetailedBrick. type AppDetailedBrick struct { - Category *string `json:"category,omitempty"` - Id string `json:"id"` - Name string `json:"name"` + Category *string `json:"category,omitempty"` + Id string `json:"id"` + Name string `json:"name"` + RequireModel *bool `json:"require_model,omitempty"` } // AppDetailedInfo defines model for AppDetailedInfo. @@ -151,6 +152,7 @@ type BrickDetailsResult struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Readme *string `json:"readme,omitempty"` + RequireModel *bool `json:"require_model,omitempty"` Status *string `json:"status,omitempty"` UsedByApps *[]AppReference `json:"used_by_apps"` Variables *map[string]BrickVariable `json:"variables,omitempty"` @@ -165,6 +167,7 @@ type BrickInstance struct { Id *string `json:"id,omitempty"` Model *string `json:"model,omitempty"` Name *string `json:"name,omitempty"` + RequireModel *bool `json:"require_model,omitempty"` Status *string `json:"status,omitempty"` // Variables Deprecated: use config_variables instead. This field is kept for backward compatibility. @@ -173,12 +176,14 @@ type BrickInstance struct { // BrickListItem defines model for BrickListItem. type BrickListItem struct { - Author *string `json:"author,omitempty"` - Category *string `json:"category,omitempty"` - Description *string `json:"description,omitempty"` - Id *string `json:"id,omitempty"` - Name *string `json:"name,omitempty"` - Status *string `json:"status,omitempty"` + Author *string `json:"author,omitempty"` + Category *string `json:"category,omitempty"` + Description *string `json:"description,omitempty"` + Id *string `json:"id,omitempty"` + Models *[]string `json:"models"` + Name *string `json:"name,omitempty"` + RequireModel *bool `json:"require_model,omitempty"` + Status *string `json:"status,omitempty"` } // BrickListResult defines model for BrickListResult. diff --git a/internal/e2e/daemon/app_test.go b/internal/e2e/daemon/app_test.go index 1de8ff641..b62b882b7 100644 --- a/internal/e2e/daemon/app_test.go +++ b/internal/e2e/daemon/app_test.go @@ -783,9 +783,10 @@ func TestAppDetails(t *testing.T) { require.Len(t, *detailsResp.JSON200.Bricks, 1) require.Equal(t, client.AppDetailedBrick{ - Id: ImageClassifactionBrickID, - Name: "Image Classification", - Category: f.Ptr("video"), + Id: ImageClassifactionBrickID, + Name: "Image Classification", + Category: f.Ptr("video"), + RequireModel: f.Ptr(true), }, (*detailsResp.JSON200.Bricks)[0], ) diff --git a/internal/e2e/daemon/brick_test.go b/internal/e2e/daemon/brick_test.go index b5f2b6d88..5dc95489e 100644 --- a/internal/e2e/daemon/brick_test.go +++ b/internal/e2e/daemon/brick_test.go @@ -83,6 +83,7 @@ func TestBricksList(t *testing.T) { require.Equal(t, bIdx.Description, *brick.Description) require.Equal(t, "Arduino", *brick.Author) require.Equal(t, "installed", *brick.Status) + require.Equal(t, bIdx.ModelRequired, *brick.RequireModel) } } diff --git a/internal/orchestrator/bricksindex/bricks_index_test.go b/internal/orchestrator/bricksindex/bricks_index_test.go index 11b11631e..b68072110 100644 --- a/internal/orchestrator/bricksindex/bricks_index_test.go +++ b/internal/orchestrator/bricksindex/bricks_index_test.go @@ -156,31 +156,44 @@ func TestBricksIndex(t *testing.T) { - name: EI_V_ANOMALY_DETECTION_MODEL default_value: /models/ootb/ei/concrete-crack-anomaly-detection.eim description: path to the model file +- id: arduino:fake_no_model + name: Camera Scanner + description: Scans a camera for barcodes and QR codes + require_container: false + ports: [] ` var index BricksIndex err := yaml.Unmarshal([]byte(x), &index) require.NoError(t, err) - require.Len(t, index.Bricks, 11) + require.Len(t, index.Bricks, 12) // Check if ports are correctly set - b, found := index.FindBrickByID("arduino:web_ui") + b_ic, found := index.FindBrickByID("arduino:web_ui") require.True(t, found) - require.Equal(t, []string{"7000"}, b.Ports) + require.Equal(t, []string{"7000"}, b_ic.Ports) // Check if variables are correctly set - b, found = index.FindBrickByID("arduino:image_classification") + b_ic, found = index.FindBrickByID("arduino:image_classification") + require.True(t, found) + require.Equal(t, "Image Classification", b_ic.Name) + require.Equal(t, "mobilenet-image-classification", b_ic.ModelName) + require.True(t, b_ic.ModelRequired) + require.Len(t, b_ic.Variables, 2) + require.Equal(t, "CUSTOM_MODEL_PATH", b_ic.Variables[0].Name) + require.Equal(t, "/opt/models/ei/", b_ic.Variables[0].DefaultValue) + require.Equal(t, "path to the custom model directory", b_ic.Variables[0].Description) + require.Equal(t, "EI_CLASSIFICATION_MODEL", b_ic.Variables[1].Name) + require.Equal(t, "/models/ootb/ei/mobilenet-v2-224px.eim", b_ic.Variables[1].DefaultValue) + require.Equal(t, "path to the model file", b_ic.Variables[1].Description) + require.False(t, b_ic.Variables[0].IsRequired()) + require.False(t, b_ic.Variables[1].IsRequired()) + + b_db, found := index.FindBrickByID("arduino:dbstorage_tsstore") + require.True(t, found) + require.False(t, b_db.ModelRequired) + + b_fake, found := index.FindBrickByID("arduino:fake_no_model") require.True(t, found) - require.Equal(t, "Image Classification", b.Name) - require.Equal(t, "mobilenet-image-classification", b.ModelName) - require.True(t, b.ModelRequired) - require.Len(t, b.Variables, 2) - require.Equal(t, "CUSTOM_MODEL_PATH", b.Variables[0].Name) - require.Equal(t, "/opt/models/ei/", b.Variables[0].DefaultValue) - require.Equal(t, "path to the custom model directory", b.Variables[0].Description) - require.Equal(t, "EI_CLASSIFICATION_MODEL", b.Variables[1].Name) - require.Equal(t, "/models/ootb/ei/mobilenet-v2-224px.eim", b.Variables[1].DefaultValue) - require.Equal(t, "path to the model file", b.Variables[1].Description) - require.False(t, b.Variables[0].IsRequired()) - require.False(t, b.Variables[1].IsRequired()) + require.False(t, b_fake.ModelRequired) } From 88a540d1eb22d4addf04f5c6c1a14ee5880a1c16 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Fri, 21 Nov 2025 15:20:22 +0100 Subject: [PATCH 06/14] rename to RequireModel --- internal/e2e/daemon/brick_test.go | 2 +- internal/orchestrator/bricks/bricks.go | 42 +++++++++---------- internal/orchestrator/bricks/types.go | 20 ++++----- .../orchestrator/bricksindex/bricks_index.go | 2 +- .../bricksindex/bricks_index_test.go | 10 ++--- internal/orchestrator/orchestrator.go | 10 ++--- 6 files changed, 43 insertions(+), 43 deletions(-) diff --git a/internal/e2e/daemon/brick_test.go b/internal/e2e/daemon/brick_test.go index 5dc95489e..649a3b9d4 100644 --- a/internal/e2e/daemon/brick_test.go +++ b/internal/e2e/daemon/brick_test.go @@ -83,7 +83,7 @@ func TestBricksList(t *testing.T) { require.Equal(t, bIdx.Description, *brick.Description) require.Equal(t, "Arduino", *brick.Author) require.Equal(t, "installed", *brick.Status) - require.Equal(t, bIdx.ModelRequired, *brick.RequireModel) + require.Equal(t, bIdx.RequireModel, *brick.RequireModel) } } diff --git a/internal/orchestrator/bricks/bricks.go b/internal/orchestrator/bricks/bricks.go index d71fc0618..0c1f62f6e 100644 --- a/internal/orchestrator/bricks/bricks.go +++ b/internal/orchestrator/bricks/bricks.go @@ -58,13 +58,13 @@ func (s *Service) List() (BrickListResult, error) { res := BrickListResult{Bricks: make([]BrickListItem, len(s.bricksIndex.Bricks))} for i, brick := range s.bricksIndex.Bricks { res.Bricks[i] = BrickListItem{ - ID: brick.ID, - Name: brick.Name, - Author: "Arduino", // TODO: for now we only support our bricks - Description: brick.Description, - Category: brick.Category, - Status: "installed", - ModelRequired: brick.ModelRequired, + ID: brick.ID, + Name: brick.Name, + Author: "Arduino", // TODO: for now we only support our bricks + Description: brick.Description, + Category: brick.Category, + Status: "installed", + RequireModel: brick.RequireModel, Models: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) string { return m.ID }), @@ -89,7 +89,7 @@ func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesRes Author: "Arduino", // TODO: for now we only support our bricks Category: brick.Category, Status: "installed", - ModelRequired: brick.ModelRequired, // TODO: in case is not set by the user, should we return false? + RequireModel: brick.RequireModel, ModelID: brickInstance.Model, // TODO: in case is not set by the user, should we return the default model? Variables: variablesMap, // TODO: do we want to show also the default value of not explicitly set variables? ConfigVariables: configVariables, @@ -123,7 +123,7 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br Author: "Arduino", // TODO: for now we only support our bricks Category: brick.Category, Status: "installed", // For now every Arduino brick are installed - ModelRequired: brick.ModelRequired, + RequireModel: brick.RequireModel, Variables: variables, ConfigVariables: configVariables, ModelID: modelID, @@ -204,18 +204,18 @@ func (s *Service) BricksDetails(id string, idProvider *app.IDProvider, return BrickDetailsResult{}, fmt.Errorf("unable to get used by apps: %w", err) } return BrickDetailsResult{ - ID: id, - Name: brick.Name, - Author: "Arduino", // TODO: for now we only support our bricks - Description: brick.Description, - Category: brick.Category, - ModelRequired: brick.ModelRequired, - Status: "installed", // For now every Arduino brick are installed - Variables: variables, - Readme: readme, - ApiDocsPath: apiDocsPath, - CodeExamples: codeExamples, - UsedByApps: usedByApps, + ID: id, + Name: brick.Name, + Author: "Arduino", // TODO: for now we only support our bricks + Description: brick.Description, + Category: brick.Category, + RequireModel: brick.RequireModel, + Status: "installed", // For now every Arduino brick are installed + Variables: variables, + Readme: readme, + ApiDocsPath: apiDocsPath, + CodeExamples: codeExamples, + UsedByApps: usedByApps, CompatibleModels: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) AIModel { return AIModel{ ID: m.ID, diff --git a/internal/orchestrator/bricks/types.go b/internal/orchestrator/bricks/types.go index 3290e72c4..3aa0afe3b 100644 --- a/internal/orchestrator/bricks/types.go +++ b/internal/orchestrator/bricks/types.go @@ -20,14 +20,14 @@ type BrickListResult struct { } type BrickListItem struct { - ID string `json:"id"` - Name string `json:"name"` - Author string `json:"author"` - Description string `json:"description"` - Category string `json:"category"` - Status string `json:"status"` - ModelRequired bool `json:"require_model"` - Models []string `json:"models"` + ID string `json:"id"` + Name string `json:"name"` + Author string `json:"author"` + Description string `json:"description"` + Category string `json:"category"` + Status string `json:"status"` + RequireModel bool `json:"require_model"` + Models []string `json:"models"` } type AppBrickInstancesResult struct { @@ -42,7 +42,7 @@ type BrickInstance struct { Status string `json:"status"` Variables map[string]string `json:"variables,omitempty" description:"Deprecated: use config_variables instead. This field is kept for backward compatibility."` ConfigVariables []BrickConfigVariable `json:"config_variables,omitempty"` - ModelRequired bool `json:"require_model,omitempty"` + RequireModel bool `json:"require_model"` ModelID string `json:"model,omitempty"` CompatibleModels []AIModel `json:"compatible_models"` } @@ -81,7 +81,7 @@ type BrickDetailsResult struct { Description string `json:"description"` Category string `json:"category"` Status string `json:"status"` - ModelRequired bool `json:"require_model"` + RequireModel bool `json:"require_model"` Variables map[string]BrickVariable `json:"variables,omitempty"` Readme string `json:"readme"` ApiDocsPath string `json:"api_docs_path"` diff --git a/internal/orchestrator/bricksindex/bricks_index.go b/internal/orchestrator/bricksindex/bricks_index.go index 5d2ca15c9..85d14254a 100644 --- a/internal/orchestrator/bricksindex/bricks_index.go +++ b/internal/orchestrator/bricksindex/bricks_index.go @@ -57,7 +57,7 @@ type Brick struct { RequireContainer bool `yaml:"require_container"` Variables []BrickVariable `yaml:"variables,omitempty"` Ports []string `yaml:"ports,omitempty"` - ModelRequired bool `yaml:"require_model,omitempty"` + RequireModel bool `yaml:"require_model"` ModelName string `yaml:"model_name,omitempty"` MountDevicesIntoContainer bool `yaml:"mount_devices_into_container,omitempty"` RequiredDevices []string `yaml:"required_devices,omitempty"` diff --git a/internal/orchestrator/bricksindex/bricks_index_test.go b/internal/orchestrator/bricksindex/bricks_index_test.go index b68072110..c0c393e48 100644 --- a/internal/orchestrator/bricksindex/bricks_index_test.go +++ b/internal/orchestrator/bricksindex/bricks_index_test.go @@ -156,7 +156,7 @@ func TestBricksIndex(t *testing.T) { - name: EI_V_ANOMALY_DETECTION_MODEL default_value: /models/ootb/ei/concrete-crack-anomaly-detection.eim description: path to the model file -- id: arduino:fake_no_model +- id: arduino:missing-model-require name: Camera Scanner description: Scans a camera for barcodes and QR codes require_container: false @@ -178,7 +178,7 @@ func TestBricksIndex(t *testing.T) { require.True(t, found) require.Equal(t, "Image Classification", b_ic.Name) require.Equal(t, "mobilenet-image-classification", b_ic.ModelName) - require.True(t, b_ic.ModelRequired) + require.True(t, b_ic.RequireModel) require.Len(t, b_ic.Variables, 2) require.Equal(t, "CUSTOM_MODEL_PATH", b_ic.Variables[0].Name) require.Equal(t, "/opt/models/ei/", b_ic.Variables[0].DefaultValue) @@ -191,9 +191,9 @@ func TestBricksIndex(t *testing.T) { b_db, found := index.FindBrickByID("arduino:dbstorage_tsstore") require.True(t, found) - require.False(t, b_db.ModelRequired) + require.False(t, b_db.RequireModel) - b_fake, found := index.FindBrickByID("arduino:fake_no_model") + bNoRequiredModel, found := index.FindBrickByID("arduino:missing-model-require") require.True(t, found) - require.False(t, b_fake.ModelRequired) + require.False(t, bNoRequiredModel.RequireModel) } diff --git a/internal/orchestrator/orchestrator.go b/internal/orchestrator/orchestrator.go index e7265c36e..58ba70bb4 100644 --- a/internal/orchestrator/orchestrator.go +++ b/internal/orchestrator/orchestrator.go @@ -673,10 +673,10 @@ type AppDetailedInfo struct { } type AppDetailedBrick struct { - ID string `json:"id" required:"true"` - Name string `json:"name" required:"true"` - Category string `json:"category,omitempty"` - ModelRequired bool `json:"require_model,omitempty"` + ID string `json:"id" required:"true"` + Name string `json:"name" required:"true"` + Category string `json:"category,omitempty"` + RequireModel bool `json:"require_model"` } func AppDetails( @@ -739,7 +739,7 @@ func AppDetails( } res.Name = bi.Name res.Category = bi.Category - res.ModelRequired = bi.ModelRequired + res.RequireModel = bi.RequireModel return res }), }, nil From 84c02bd045d9ebdd07f8b9408e3be030ec765505 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Tue, 25 Nov 2025 15:06:07 +0100 Subject: [PATCH 07/14] TestBricksList test --- internal/orchestrator/bricks/bricks_test.go | 13 ------------ .../bricks/testdata/bricks-list.yaml | 20 +++++++++++++++++++ 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/internal/orchestrator/bricks/bricks_test.go b/internal/orchestrator/bricks/bricks_test.go index f9804b251..b6b2f3f84 100644 --- a/internal/orchestrator/bricks/bricks_test.go +++ b/internal/orchestrator/bricks/bricks_test.go @@ -252,19 +252,6 @@ func TestGetBrickInstanceVariableDetails(t *testing.T) { expectedConfigVariables []BrickConfigVariable expectedVariableMap map[string]string }{ - { - name: "variable is present in the map", - brick: &bricksindex.Brick{ - Variables: []bricksindex.BrickVariable{ - {Name: "VAR1", Description: "desc"}, - }, - }, - userVariables: map[string]string{"VAR1": "value1"}, - expectedConfigVariables: []BrickConfigVariable{ - {Name: "VAR1", Value: "value1", Description: "desc", Required: true}, - }, - expectedVariableMap: map[string]string{"VAR1": "value1"}, - }, { name: "variable not present in the map", brick: &bricksindex.Brick{ diff --git a/internal/orchestrator/bricks/testdata/bricks-list.yaml b/internal/orchestrator/bricks/testdata/bricks-list.yaml index 8e3114d60..e730639eb 100644 --- a/internal/orchestrator/bricks/testdata/bricks-list.yaml +++ b/internal/orchestrator/bricks/testdata/bricks-list.yaml @@ -23,3 +23,23 @@ bricks: mount_devices_into_container: false ports: [] category: storage +- id: arduino:image_classification + name: Image Classification + description: "Brick for image classification using a pre-trained model. It processes\ + \ images and returns the predicted class label and confidence score.\nBrick is\ + \ designed to work with pre-trained models provided by framework or with custom\ + \ image classification models trained on Edge Impulse platform. \n" + require_container: true + require_model: true + require_devices: false + mount_devices_into_container: false + ports: [] + category: video + model_name: mobilenet-image-classification + variables: + - name: CUSTOM_MODEL_PATH + default_value: /home/arduino/.arduino-bricks/ei-models + description: path to the custom model directory + - name: EI_CLASSIFICATION_MODEL + default_value: /models/ootb/ei/mobilenet-v2-224px.eim + description: path to the model file From 66d47820c2bf7b258e5e96c1c302ab57e9a793c8 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Tue, 25 Nov 2025 15:44:55 +0100 Subject: [PATCH 08/14] TestAppBrickInstanceDetails --- internal/orchestrator/bricks/bricks_test.go | 40 +++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/internal/orchestrator/bricks/bricks_test.go b/internal/orchestrator/bricks/bricks_test.go index b6b2f3f84..ec74e0705 100644 --- a/internal/orchestrator/bricks/bricks_test.go +++ b/internal/orchestrator/bricks/bricks_test.go @@ -626,3 +626,43 @@ func TestAppBrickInstanceModelsDetails(t *testing.T) { }) } } + +func TestAppBrickInstanceDetails(t *testing.T) { + bricksIndex, err := bricksindex.GenerateBricksIndexFromFile(paths.New("testdata")) + require.Nil(t, err) + brickService := NewService(nil, bricksIndex, nil) + tempDirectory := t.TempDir() + + app := app.ArduinoApp{ + Name: "TestApp", + Descriptor: app.AppDescriptor{ + Bricks: []app.Brick{ + { + ID: "arduino:image_classification", + }, + }, + }, + FullPath: paths.New(tempDirectory), + } + configVariables, _ := brickService.AppBrickInstanceDetails(&app, bricksIndex.Bricks[2].ID) + + expectedConfigVariables := BrickInstance{ + Name: "Image Classification", + ID: "arduino:image_classification", + Author: "Arduino", + Category: "video", + Status: "installed", + Variables: map[string]string{ + "CUSTOM_MODEL_PATH": "/home/arduino/.arduino-bricks/ei-models", + "EI_CLASSIFICATION_MODEL": "/models/ootb/ei/mobilenet-v2-224px.eim", + }, + ConfigVariables: []BrickConfigVariable{ + {Name: "CUSTOM_MODEL_PATH", Value: "/home/arduino/.arduino-bricks/ei-models", Description: "path to the custom model directory", Required: false}, + {Name: "EI_CLASSIFICATION_MODEL", Value: "/models/ootb/ei/mobilenet-v2-224px.eim", Description: "path to the model file", Required: false}, + }, + RequireModel: true, + ModelID: "mobilenet-image-classification", + } + + require.Equal(t, expectedConfigVariables, configVariables) +} From 0a49ae42d2ac235a51434d8d41cb95f115b2f111 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Tue, 25 Nov 2025 15:47:13 +0100 Subject: [PATCH 09/14] fix --- internal/orchestrator/bricks/bricks_test.go | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/internal/orchestrator/bricks/bricks_test.go b/internal/orchestrator/bricks/bricks_test.go index ec74e0705..05d3b01cf 100644 --- a/internal/orchestrator/bricks/bricks_test.go +++ b/internal/orchestrator/bricks/bricks_test.go @@ -252,6 +252,19 @@ func TestGetBrickInstanceVariableDetails(t *testing.T) { expectedConfigVariables []BrickConfigVariable expectedVariableMap map[string]string }{ + { + name: "variable is present in the map", + brick: &bricksindex.Brick{ + Variables: []bricksindex.BrickVariable{ + {Name: "VAR1", Description: "desc"}, + }, + }, + userVariables: map[string]string{"VAR1": "value1"}, + expectedConfigVariables: []BrickConfigVariable{ + {Name: "VAR1", Value: "value1", Description: "desc", Required: true}, + }, + expectedVariableMap: map[string]string{"VAR1": "value1"}, + }, { name: "variable not present in the map", brick: &bricksindex.Brick{ From 127e56fc9eba978df79272e65bff7423a9e44b60 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Wed, 26 Nov 2025 11:46:16 +0100 Subject: [PATCH 10/14] generate --- internal/api/docs/openapi.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/internal/api/docs/openapi.yaml b/internal/api/docs/openapi.yaml index f32c9a769..1419b4493 100644 --- a/internal/api/docs/openapi.yaml +++ b/internal/api/docs/openapi.yaml @@ -1390,6 +1390,11 @@ components: type: string id: type: string + models: + items: + type: string + nullable: true + type: array name: type: string require_model: From edaad5d483acedf0d3ac1cfc9b5fe86de8e3b2d8 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Wed, 26 Nov 2025 11:50:37 +0100 Subject: [PATCH 11/14] require --- internal/orchestrator/bricksindex/bricks_index_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/orchestrator/bricksindex/bricks_index_test.go b/internal/orchestrator/bricksindex/bricks_index_test.go index c0c393e48..861d066c4 100644 --- a/internal/orchestrator/bricksindex/bricks_index_test.go +++ b/internal/orchestrator/bricksindex/bricks_index_test.go @@ -193,7 +193,7 @@ func TestBricksIndex(t *testing.T) { require.True(t, found) require.False(t, b_db.RequireModel) - bNoRequiredModel, found := index.FindBrickByID("arduino:missing-model-require") + bNoRequireModel, found := index.FindBrickByID("arduino:missing-model-require") require.True(t, found) - require.False(t, bNoRequiredModel.RequireModel) + require.False(t, bNoRequireModel.RequireModel) } From 3a6ef3ef9b55132e4cd6ddb814fee6e3aca27c10 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Wed, 26 Nov 2025 11:53:17 +0100 Subject: [PATCH 12/14] fix --- .../bricksindex/bricks_index_test.go | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/internal/orchestrator/bricksindex/bricks_index_test.go b/internal/orchestrator/bricksindex/bricks_index_test.go index 861d066c4..abd772eba 100644 --- a/internal/orchestrator/bricksindex/bricks_index_test.go +++ b/internal/orchestrator/bricksindex/bricks_index_test.go @@ -169,29 +169,29 @@ func TestBricksIndex(t *testing.T) { require.Len(t, index.Bricks, 12) // Check if ports are correctly set - b_ic, found := index.FindBrickByID("arduino:web_ui") + bWebUI, found := index.FindBrickByID("arduino:web_ui") require.True(t, found) - require.Equal(t, []string{"7000"}, b_ic.Ports) + require.Equal(t, []string{"7000"}, bWebUI.Ports) // Check if variables are correctly set - b_ic, found = index.FindBrickByID("arduino:image_classification") + bWebUI, found = index.FindBrickByID("arduino:image_classification") require.True(t, found) - require.Equal(t, "Image Classification", b_ic.Name) - require.Equal(t, "mobilenet-image-classification", b_ic.ModelName) - require.True(t, b_ic.RequireModel) - require.Len(t, b_ic.Variables, 2) - require.Equal(t, "CUSTOM_MODEL_PATH", b_ic.Variables[0].Name) - require.Equal(t, "/opt/models/ei/", b_ic.Variables[0].DefaultValue) - require.Equal(t, "path to the custom model directory", b_ic.Variables[0].Description) - require.Equal(t, "EI_CLASSIFICATION_MODEL", b_ic.Variables[1].Name) - require.Equal(t, "/models/ootb/ei/mobilenet-v2-224px.eim", b_ic.Variables[1].DefaultValue) - require.Equal(t, "path to the model file", b_ic.Variables[1].Description) - require.False(t, b_ic.Variables[0].IsRequired()) - require.False(t, b_ic.Variables[1].IsRequired()) + require.Equal(t, "Image Classification", bWebUI.Name) + require.Equal(t, "mobilenet-image-classification", bWebUI.ModelName) + require.True(t, bWebUI.RequireModel) + require.Len(t, bWebUI.Variables, 2) + require.Equal(t, "CUSTOM_MODEL_PATH", bWebUI.Variables[0].Name) + require.Equal(t, "/opt/models/ei/", bWebUI.Variables[0].DefaultValue) + require.Equal(t, "path to the custom model directory", bWebUI.Variables[0].Description) + require.Equal(t, "EI_CLASSIFICATION_MODEL", bWebUI.Variables[1].Name) + require.Equal(t, "/models/ootb/ei/mobilenet-v2-224px.eim", bWebUI.Variables[1].DefaultValue) + require.Equal(t, "path to the model file", bWebUI.Variables[1].Description) + require.False(t, bWebUI.Variables[0].IsRequired()) + require.False(t, bWebUI.Variables[1].IsRequired()) - b_db, found := index.FindBrickByID("arduino:dbstorage_tsstore") + bDb, found := index.FindBrickByID("arduino:dbstorage_tsstore") require.True(t, found) - require.False(t, b_db.RequireModel) + require.False(t, bDb.RequireModel) bNoRequireModel, found := index.FindBrickByID("arduino:missing-model-require") require.True(t, found) From 76477e7ff91c3977101cb8011a9484702f849e38 Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Wed, 26 Nov 2025 12:02:01 +0100 Subject: [PATCH 13/14] add require test --- internal/orchestrator/bricks/bricks_test.go | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/internal/orchestrator/bricks/bricks_test.go b/internal/orchestrator/bricks/bricks_test.go index 05d3b01cf..557ba5947 100644 --- a/internal/orchestrator/bricks/bricks_test.go +++ b/internal/orchestrator/bricks/bricks_test.go @@ -503,12 +503,14 @@ func TestAppBrickInstanceModelsDetails(t *testing.T) { {Name: "EI_OBJ_DETECTION_MODEL", DefaultValue: "default_path", Description: "path to the model file"}, {Name: "CUSTOM_MODEL_PATH", DefaultValue: "/home/arduino/.arduino-bricks/ei-models", Description: "path to the custom model directory"}, }, + RequireModel: true, }, { - ID: "arduino:weather_forecast", - Name: "Weather Forecast", - Category: "miscellaneous", - ModelName: "", + ID: "arduino:weather_forecast", + Name: "Weather Forecast", + Category: "miscellaneous", + ModelName: "", + RequireModel: false, }, }, } @@ -577,6 +579,7 @@ func TestAppBrickInstanceModelsDetails(t *testing.T) { require.Equal(t, "installed", res.Status) require.Empty(t, res.ModelID) require.Empty(t, res.CompatibleModels) + require.False(t, res.RequireModel) }, }, { @@ -597,6 +600,7 @@ func TestAppBrickInstanceModelsDetails(t *testing.T) { require.Len(t, res.CompatibleModels, 2) require.Equal(t, "yolox-object-detection", res.CompatibleModels[0].ID) require.Equal(t, "face-detection", res.CompatibleModels[1].ID) + require.True(t, res.RequireModel) }, }, { @@ -618,6 +622,7 @@ func TestAppBrickInstanceModelsDetails(t *testing.T) { require.Len(t, res.CompatibleModels, 2) require.Equal(t, "yolox-object-detection", res.CompatibleModels[0].ID) require.Equal(t, "face-detection", res.CompatibleModels[1].ID) + require.True(t, res.RequireModel) }, }, } From 6a7cdae3e3e76027651ae1637f4624216396520e Mon Sep 17 00:00:00 2001 From: Giulio Pilotto Date: Wed, 26 Nov 2025 12:09:15 +0100 Subject: [PATCH 14/14] unrelated test --- internal/orchestrator/bricks/bricks_test.go | 40 --------------------- 1 file changed, 40 deletions(-) diff --git a/internal/orchestrator/bricks/bricks_test.go b/internal/orchestrator/bricks/bricks_test.go index 557ba5947..c79e5fb65 100644 --- a/internal/orchestrator/bricks/bricks_test.go +++ b/internal/orchestrator/bricks/bricks_test.go @@ -644,43 +644,3 @@ func TestAppBrickInstanceModelsDetails(t *testing.T) { }) } } - -func TestAppBrickInstanceDetails(t *testing.T) { - bricksIndex, err := bricksindex.GenerateBricksIndexFromFile(paths.New("testdata")) - require.Nil(t, err) - brickService := NewService(nil, bricksIndex, nil) - tempDirectory := t.TempDir() - - app := app.ArduinoApp{ - Name: "TestApp", - Descriptor: app.AppDescriptor{ - Bricks: []app.Brick{ - { - ID: "arduino:image_classification", - }, - }, - }, - FullPath: paths.New(tempDirectory), - } - configVariables, _ := brickService.AppBrickInstanceDetails(&app, bricksIndex.Bricks[2].ID) - - expectedConfigVariables := BrickInstance{ - Name: "Image Classification", - ID: "arduino:image_classification", - Author: "Arduino", - Category: "video", - Status: "installed", - Variables: map[string]string{ - "CUSTOM_MODEL_PATH": "/home/arduino/.arduino-bricks/ei-models", - "EI_CLASSIFICATION_MODEL": "/models/ootb/ei/mobilenet-v2-224px.eim", - }, - ConfigVariables: []BrickConfigVariable{ - {Name: "CUSTOM_MODEL_PATH", Value: "/home/arduino/.arduino-bricks/ei-models", Description: "path to the custom model directory", Required: false}, - {Name: "EI_CLASSIFICATION_MODEL", Value: "/models/ootb/ei/mobilenet-v2-224px.eim", Description: "path to the model file", Required: false}, - }, - RequireModel: true, - ModelID: "mobilenet-image-classification", - } - - require.Equal(t, expectedConfigVariables, configVariables) -}