Technical Onboarding Guide
This guide walks you through the FlexHome․Energy onboarding workflow, covering everything from initial contact through to training. Each phase below describes the activities carried out by you (the customer) and by the FlexHome․Energy team.
Initial Contact
- The customer and the FlexHome․Energy sales team collect information about the customer's use case. This is done via direct contact and/or by filling out the questionnaire at flexhome.energy/formular.
- The FlexHome․Energy sales team kicks off the evaluation phase by inviting technical staff from both the customer and FlexHome․Energy.
Evaluation
The engineering teams of the customer and FlexHome․Energy specify the integration details in an engineering meeting.
Integration Details Reviewed
| Topic | Description |
|---|---|
| Possible integration techniques | Which interfaces does the energy provider support for controlling the batteries and obtaining the metering information? Standard protocol, FlexHome․Energy HTTP interface, or FlexHome․Energy SDK. |
| Programming language | The programming language of the platform determines the programming language for which FlexHome․Energy needs to provide an SDK. |
| Operating system | Which operating system is the energy provider running on? |
Integration Techniques and Development Tools
| Topic | Description |
|---|---|
| API technology | The IoT platform description. |
| FlexCloud SDK | The software development kit for the programming language and operating system of the customer. |
| FlexCloud Development client | The development client that provides an HTTP interface to immediately start using the platform. |
| Documentation | The onboarding documentation, consisting of a description of the first steps. |
After the meeting:
- The FlexHome․Energy engineering team compiles a list of deliverables to be provided to the customer for controlling the batteries via FlexCloud.
- FlexHome․Energy kicks off the setup phase internally.
Setup
The setup phase consists of two parallel streams: FlexCloud setup and hardware setup.
FlexCloud Setup
The FlexHome․Energy cloud team:
- Creates virtual devices.
- Creates communication certificates.
- Provides device identifiers (SKI) to the hardware team.
- Updates each virtual device with information provided by the hardware team.
- Sets the battery serial number per device.
- Sets the LTE number per device.
- Creates the customer account.
- Creates a customer-specific group in FlexCloud.
- Creates a customer-specific user in FlexCloud.
- Assigns the devices to the customer-specific group for operation.
- Provides device information to the ERP team:
- Identifiers
- Customer information
Hardware Setup
The FlexHome․Energy hardware team:
- Obtains SIM(s) for LTE communication from the communication network provider (A1).
- Obtains the device identifiers (SKI) from the cloud team.
- Assigns a SIM per device and provides the device serial number along with the LTE number to the cloud team.
- Obtains the RAPID communication hardware (Teltonika).
- Registers the devices on the RAPID server.
- Provides device information to the ERP team:
- Battery addresses
Delivery
Software Delivery
The FlexHome․Energy cloud team provides the customer's engineering team with:
- The API credentials.
- The development client for:
- Windows
- Linux
- macOS
- The SDK, depending on the integration technique chosen during evaluation.
- The quick start guide.
Hardware Delivery
The FlexHome․Energy hardware team ships the batteries to the customer.
Training
The FlexHome․Energy cloud engineering team and the customer's engineering team conduct a meeting to walk through the first steps.
Step 1 — Preparation
The customer's engineering team:
- Downloads the development client.
- Downloads the quick start guide.
Step 2 — First Requests
The customer's engineering team:
- Runs the development client.
- Executes the following requests:
BatteryStateRequestBatteryControlRequestBatteryControlModifyRequest
Next Steps
For details on running these requests, see the FlexConnect API User Guide — First Steps.