Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation #486

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update Documentation #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3c67494
settings moved to user guide
Feb 18, 2025
aeb0635
reordered
Feb 18, 2025
12dad71
removed wrong sections.
Feb 18, 2025
57f1722
updated.
Feb 19, 2025
c3892ba
revert email envs
Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/installation/deploy-production.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
order: 4
order: 3
---

# Deploy for Production
Expand Down
77 changes: 0 additions & 77 deletions docs/installation/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,87 +142,10 @@ Configure the following environment variable to enable MicroPowerManager to send
Certain MicroPowerManager plugins require configuration before they can be used.
Find below a reference of configurations which are required if the corresponding plugin is used.

#### Airtel

For detailed information see [Airtel Developer Documentation](https://developers.airtel.africa/developer).

| Environment Variable | Default | Description |
| -------------------- | ---------------------------------- | ------------------------------------------- |
| `AIRTEL_REQUEST_URL` | **Required** (when plugin is used) | The Airtel service URL. |
| `AIRTEL_USERNAME` | **Required** (when plugin is used) | The Airtel username. |
| `AIRTEL_PASSWORD` | **Required** (when plugin is used) | The Airtel password. |
| `AIRTEL_IPS` | `[]` | List of IP whitelisted for Airtel services. |
Comment on lines -149 to -154
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem used.

please don't remove them

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AirtelTransactionProvider should be removed. We need to develop a plugin for Airtel If we're planning that in future.


#### Calin STS Meters

For detailed information see [Calin Meter Developer Documentation](https://www.szcalinmeter.com/).

| Environment Variable | Default | Description |
| -------------------- | ---------------------------------- | -------------------------------------------------------- |
| `CALIN_CLIENT_URL` | **Required** (when plugin is used) | Calin Meter client URL used for generating STS tokens. |
| `CALIN_USER_ID` | **Required** (when plugin is used) | Calin Meter API username used for generating STS tokens. |
| `CALIN_KEY` | **Required** (when plugin is used) | Calin Meter API key used for generating STS tokens. |
Comment on lines -160 to -164
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem used

Please don't remove them

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CalinReadMeter.php is not using. We have plugins for Calin & Calin Smart meters. The code sample you shared me is legacy code from very old versions of MPM. So that can be removed.


If you meters are used which can send their consumption data to Calin's
API the following environment variables need to be set.

| Environment Variable | Default | Description |
| -------------------- | ---------------------------------- | ---------------------------------------------------------- |
| `METER_DATA_URL` | **Required** (when plugin is used) | Calin Meter API URL used for consumption data upload. |
| `METER_DATA_KEY` | **Required** (when plugin is used) | Calin Meter API key used for consumption data upload. |
| `METER_DATA_USER` | **Required** (when plugin is used) | Calin Meter API username used for consumption data upload. |
Comment on lines -169 to -173
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem used

Please don't remove

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CalinReadMeter.php is not using. We have plugins for Calin & Calin Smart meters. The code sample you shared me is legacy code from very old versions of MPM. So that can be removed.


#### Calin Smart Meters

For detailed information see [Calin Smart Meter Developer Documentation](https://www.szcalinmeter.com/).

| Environment Variable | Default | Description |
| ------------------------------ | ---------------------------------- | ------------------------------------------------------------------------- |
| `CALIN_SMART_COMPANY_NAME` | **Required** (when plugin is used) | Calin Smart Meter company name used for communication with Calin API. |
| `CALIN_SMART_PURCHASE_API_URL` | **Required** (when plugin is used) | Calin Smart Meter Purchase API URL used for communication with Calin API. |
| `CALIN_SMART_CLEAR_API_URL` | **Required** (when plugin is used) | Calin Smart Meter Clear API URL used for communication with Calin API. |
| `CALIN_SMART_USER_NAME` | **Required** (when plugin is used) | Calin Smart Meter username used for communication with Calin API. |
| `CALIN_SMART_PASSWORD` | **Required** (when plugin is used) | Calin Smart Meter password used for communication with Calin API. |
| `CALIN_SMART_PASSWORD_VENT` | **Required** (when plugin is used) | Calin Smart Meter password vent used for communication with Calin API. |
Comment on lines -175 to -186
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also remove the corresponding section in services.php. https://github.com/EnAccess/micropowermanager/blob/main/src/backend/config/services.php#L55-L64

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CalinReadMeter.php is not using. We have plugins for Calin & Calin Smart meters. The code sample you shared me is legacy code from very old versions of MPM. So that can be removed.


#### Vodacom

Vodacom integration requires a VPN tunnel with Vodacom infrastructure.
For detailed information see [Vodacom Developer Documentation](https://business.m-pesa.com/vodacom-tanzania/business-onboarding-tanzania/)

| Environment Variable | Default | Description |
| ------------------------------- | ---------------------------------- | --------------------------- |
| `VODACOM_SPID` | **Required** (when plugin is used) | Vodacom SPID. |
| `VODACOM_SPPASSWORD` | **Required** (when plugin is used) | Vodacom SPPASSWORD. |
| `VODACOM_IPS` | **Required** (when plugin is used) | Vodacom IPs. |
| `VODACOM_REQUEST_URL` | **Required** (when plugin is used) | Vodacom Request API URL. |
| `VODACOM_BROKER_CRT` | **Required** (when plugin is used) | Path to broker `.crt` file. |
| `VODACOM_SLL_KEY` | **Required** (when plugin is used) | Path to `.key` file. |
| `VODACOM_CERTIFICATE_AUTHORITY` | **Required** (when plugin is used) | Path to `.cer` file. |
| `VODACOM_SSL_CERT` | **Required** (when plugin is used) | Path to `.pem` file. |
Comment on lines -193 to -202
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem used

Please don't remove them

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VodacomTransactionProvider should be removed. We need to develop a plugin for Airtel If we're planning that in future.


#### SunKing

For detailed information see [SunKing Developer Documentation](https://sunking.com/)

| Environment Variable | Default | Description |
| -------------------- | ---------------------------------- | -------------------------------------------------------------------------------- |
| `SUNKING_API_URL` | **Required** (when plugin is used) | SunKing API URL. For example `https://dev.assetcontrol.central.glp apps.com/v2`. |

Comment on lines -208 to -211
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has to stay for now, see below

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

#### WaveMoney

For detailed information see [WaveMoney Developer Documentation](https://partners.wavemoney.com.mm/documentation)

| Environment Variable | Default | Description |
| -------------------- | ---------------------------------- | --------------------------------------------------------------------------- |
| `WAVEMONEY_API_URL` | **Required** (when plugin is used) | WaveMoney API URL. For example `https://preprodpayments.wavemoney.io:8107`. |

#### BingMaps

> [!WARNING]
> BingMaps is deprecated in favour of OpenStreetMap.
> It's not recommended for production use.

| Environment Variable | Default | Description |
| -------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
| `BINGMAP_API_URL` | **Required** (when BingMaps is used) | BingMaps API URL (including the API key). For example `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/Aerial?key=` |
2 changes: 1 addition & 1 deletion docs/installation/essential.md → docs/usage-guide/essential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
order: 3
order: 20
---

# Micropower Manager Settings
Expand Down
2 changes: 1 addition & 1 deletion src/backend/database/migrations/micropowermanager/2022_14_12_create_sun_king_tables.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function up() {
Schema::connection('tenant')->create('sun_king_api_credentials', static function (Blueprint $table) {
$table->increments('id');
$table->string('auth_url')->default('https://auth.central.glpapps.com/auth/realms/glp-dev/protocol/openid-connect/token');
$table->string('api_url')->default(config('services.sunKing.url'));
$table->string('api_url')->default('https://assetcontrol.central.glpapps.com/v2');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can only do this, once we have a section in the WebUI for Tenants to set their SunKing URL. Please remove it for now.

Copy link
Contributor Author

@93Kamuran 93Kamuran Mar 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fixed value, So we need to set it into "sun_king_api_credentials" table with default value once "install plugin" command runs. We do not need to show this information on UI side.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would I (as a platform admin) then change my development environment to use the SunKing sandbox?

$table->string('client_id')->nullable();
$table->string('client_secret')->nullable();
$table->text('access_token')->nullable();
Expand Down
Loading