Implementation Examples

Current examples are repository workflows and designer behavior checks. There is no packaged BatteryBee SDK or public project API to install.

Designer workflows

Create a pack

Open /designer, create a project, set target voltage/capacity/current, choose a cell, and continue into the v2 workspace.

Prepare manufacturable output

Finish Geometry, Case, Layout, Series, and Busbars before exporting. The export tab packages generated backend files into a browser zip.

Estimate resistance

Configure series wiring and busbars, then use Reports. BatteryBee sends the current layer and material assumptions to its internal estimator.

Backend request pattern

  • Build or normalize a ViewerScene from DesignerState.
  • Include the relevant editor settings: case mode for case export, spacer settings for spacers, busbar layer/fold settings for busbars.
  • Call the internal service wrapper for the artifact you need.
  • Handle non-OK responses as request failures and surface backend text where available.
  • Decode generated parts or save binary responses according to the service wrapper contract.

Useful local checks

  • flow:designer:create for the project creation path.
  • flow:designer:add-keepout for keep-out creation behavior.
  • flow:designer:drag-keepout for keep-out move behavior.
  • flow:designer:delete-keepout for keep-out removal behavior.
  • ss:capture-home for maintained docs screenshots.
  • pytest backend/tests for backend geometry/export expectations.