Development

Development Path

1. Before module-level changes, read Backend Architecture, Frontend Architecture, and Data Architecture.
2. Locate backend APIs with Backend Module Map, and understand table/API relationships with Data Model And API Map.
3. For Vue3 page, API, and permission development, start with Vue3 Frontend Development.
4. For device protocol extension, read Protocol Management, Topic Notes, and Modbus Development.
5. For rules and message processing, read Rule Engine, Rule Visualization, and Script Notes.
6. For AI extension, read AI Secondary Development. For SCADA and dashboard extension, read Visualization And SCADA Development.
7. For firmware upgrade, device pairing, and gateway collection, read the OTA, device pairing, and gateway documents.

Common Tasks

Backend Module MapLocate Controller, module responsibility, API prefix, and source directory by business function.Data Model MapUnderstand business data relationships by table prefix, API, and frontend entry.Vue3 DevelopmentLocal development, API integration, route permission, OpenAPI, and verification.Extend Device ProtocolsProtocol management, decoding, encoding, and protocol collections.Review ArchitectureUnderstand frontend, backend, data, deployment, and performance boundaries before secondary development.Develop Rule ScriptsUnderstand rule-engine context, script objects, and message forwarding.AI DevelopmentProvider, model, knowledge base, protocol adaptation, NL2SQL, and source-code knowledge.Visualization DevelopmentDesigner, SCADA components, variable binding, events, and asset maintenance.Code GeneratorTable import, field configuration, preview, generation, permission, and integration checks.Develop OTA CapabilityDevice upgrade flow, firmware types, and upgrade topics.Develop Gateway CollectionGateway, sub-device, and collection-link design.Read Database NotesTable structures, data flow, and secondary-development concerns.Read Topic NotesDevice topics, platform topics, and message-flow conventions.