Voltimax Platform

Appearance

Naming Conventions ​

This guide defines naming standards for resources in the Voltimax IoT Platform.

Azure Functions ​

Individual Function Naming ​

Format ​

Function names should use PascalCase and follow a verb-noun pattern that clearly describes the function's purpose.

text
{Verb}{DomainEntity}

Choose verbs that accurately describe the operation:

  • Process - Transform or handle data
  • Handle - Respond to events or requests
  • Validate - Check data integrity or business rules
  • Aggregate - Combine or summarize data
  • Transform - Convert data between formats
  • Store - Persist data to storage
  • Retrieve - Fetch data from storage
  • Calculate - Perform computations
  • Send - Transmit data to external systems
  • Receive - Accept data from external systems

Examples by Trigger Type ​

HTTP Triggers:

  • HandleMetricUpload
  • GetDeviceStatus
  • UpdateGatewayConfiguration

Timer Triggers:

  • AggregateHourlyMetrics
  • CleanupOldData
  • GenerateDailyReports

Queue/Service Bus Triggers:

  • ProcessMetricBatch
  • HandleDeviceCommand
  • StoreIncomingTelemetry

Naming Guidelines ​

  • Maximum length: 50 characters
  • Be descriptive: Avoid abbreviations that sacrifice clarity
  • Include domain context: Reference the entity being operated on (Metrics, Gateway, Device, Battery, etc.)
  • Avoid generic names: Do not use Function1, Handler, Processor without context
  • Match C# conventions: Use PascalCase to align with .NET standards

Examples to Avoid ​

❌ Function1 ❌ PrcMtrc (unclear abbreviation) ❌ DoStuff (not descriptive) ❌ Handler (too generic)

Examples to Follow ​

✅ IngestMetricBatch ✅ ValidateMetricData ✅ StoreToElasticsearch ✅ CalculateTariffMetrics