NZ Power Outage Monitoring

Power Outages API - Aggregated power outage data from New Zealand electricity distribution boards including Orion Group, PowerCo, and Wellington Electricity.

Power outages are displayed on the TAK map with the following information:

• Utility name and affected area
• Number of customers affected
• Outage cause and status
• Estimated restoration time
• Crew status (when available)
• Affected streets and areas

Deployment into the CloudTAK environment for ETL tasks is done via automatic releases to the TAK.NZ AWS environment.

Github actions will build and push docker releases on every version tag which can then be automatically configured via the CloudTAK API.

The workflow uses GitHub variables and secrets to make it reusable across different ETL repositories.

• DEMO_STACK_NAME: Name of the demo stack (default: "Demo")
• PROD_STACK_NAME: Name of the production stack (default: "Prod")

• DEMO_AWS_ACCOUNT_ID: AWS account ID for demo environment
• DEMO_AWS_REGION: AWS region for demo environment
• DEMO_AWS_ROLE_ARN: IAM role ARN for demo environment
• PROD_AWS_ACCOUNT_ID: AWS account ID for production environment
• PROD_AWS_REGION: AWS region for production environment
• PROD_AWS_ROLE_ARN: IAM role ARN for production environment

• ETL_NAME: Name of the ETL (default: repository name)

• AWS_ACCOUNT_ID: AWS account ID for the environment
• AWS_REGION: AWS region for the environment
• AWS_ROLE_ARN: IAM role ARN for the environment

These variables and secrets can be set in the GitHub organization or repository settings under Settings > Secrets and variables.

For manual deployment you can use the scripts/etl/deploy-etl.sh script from the CloudTAK repo. As an example:

../CloudTAK/scripts/etl/deploy-etl.sh Demo v1.0.0 --profile tak-nz-demo

When registering this ETL as a task in CloudTAK:

• Use the <repo-name>.png file in the main folder of this repository as the Task Logo
• Use the raw GitHub URL of this README.md file as the Task Markdown Readme URL

This will ensure proper visual identification and documentation for the task in the CloudTAK interface.

• API_URL: Power Outages API endpoint (default: https://utils.tak.nz/power-outages/outages)
• Min Customers: Minimum number of customers affected to display (default: 0)
• Utility Filter: Filter by specific utility (e.g., ORION_NZ, POWERCO_NZ, WELLINGTON_NZ)
• Outage Type: Filter by outage type (planned, unplanned)

Color code outages by customer impact using CloudTAK styling overrides:

• Color: #FFFFFF or rgb(255, 255, 255)
• JSONata: properties.metadata.customersAffected >= 1 and properties.metadata.customersAffected < 10

• Color: #FFFF00 or rgb(255, 255, 0)
• JSONata: properties.metadata.customersAffected >= 10 and properties.metadata.customersAffected < 50

• Color: #FFA500 or rgb(255, 165, 0)
• JSONata: properties.metadata.customersAffected >= 50 and properties.metadata.customersAffected < 100

• Color: #FF0000 or rgb(255, 0, 0)
• JSONata: properties.metadata.customersAffected >= 100 and properties.metadata.customersAffected < 500

• Color: #800080 or rgb(128, 0, 128)
• JSONata: properties.metadata.customersAffected >= 500

TAK.NZ provided Lambda ETLs are currently all written in NodeJS through the use of a AWS Lambda optimized Docker container. Documentation for the Dockerfile can be found in the AWS Help Center

npm install

Add a .env file in the root directory that gives the ETL script the necessary variables to communicate with a local ETL server. When the ETL is deployed the ETL_API and ETL_LAYER variables will be provided by the Lambda Environment

{
    "ETL_API": "http://localhost:5001",
    "ETL_LAYER": "19"
}

To run the task, ensure the local CloudTAK server is running and then run with typescript runtime or build to JS and run natively with node

ts-node task.ts

npm run build
cp .env dist/
node dist/task.js

TAK.NZ is distributed under AGPL-3.0-only Copyright (C) 2025 - Christian Elsen, Team Awareness Kit New Zealand (TAK.NZ)