✍️
BR Writing Samples
  • Product documentation sample
    • Product Manual: Task Tracker Application
    • Installation Guide: Project Management Software
    • Release Notes: Project Management Software v2.5
    • User Story: Tracking Project Progress
    • Epic: Enhance User Onboarding Experience for EcoTrack
    • User Story: Integrate Data Analytics Dashboard in EcoTrack
  • Sample blogs
    • Cloud Computing: Transforming the Future
    • The Impact of Blockchain on Various Industries
    • Embracing DevOps: The Future of Software Development
    • The Journey of AI Technology: From Concept to Reality
    • GraphQL vs. REST APIs: A Technical Writer's Guide
  • Technical/API documentation samples
    • EcoTrack SDK Documentation
    • Inventory Management API
    • User Management API
    • Payment Processing API
    • BRConnect API Integration Guide
    • EcoTrack SDK Guide: Creating Environmental Reports
    • Installation Guide for FrankTech Suite (following DITA standards)
    • Help Article - Exporting Environmental Data from EcoTrack
    • Troubleshooting Guide - How to Resolve EcoTrack Software Login Issues
    • Enhancing Supply Chain Visibility with BR Yard Management Solutions
    • Work Item Models API Documentation
Powered by GitBook
On this page
  • Introduction
  • Installation
  • Prerequisites
  • Download
  • Importing the SDK
  • Getting Started
  • Initializing the SDK
  • Configuration
  • Features
  • Carbon Emission Tracking
  • Renewable Energy Tracking
  • Sustainability Reports
  • API Reference
  • EcoTrackManager
  • Support
  1. Technical/API documentation samples

EcoTrack SDK Documentation

PreviousTechnical/API documentation samplesNextInventory Management API

Welcome to the EcoTrack SDK documentation. This guide will help you integrate EcoTrack into your application to monitor and manage environmental data efficiently.

Introduction

EcoTrack SDK provides tools and APIs to integrate environmental data tracking into your applications. With EcoTrack, you can monitor carbon emissions, track renewable energy usage, and generate sustainability reports.

Installation

Prerequisites

  • Unity 2019.4 or later

  • .NET Standard 2.0 or later

Download

Download the latest version of the EcoTrack SDK from the .

Importing the SDK

  1. Open your Unity project.

  2. Go to Assets > Import Package > Custom Package.

  3. Select the downloaded EcoTrack SDK package.

  4. Click Import to add the SDK to your project.

Getting Started

Initializing the SDK

To start using the EcoTrack SDK, you need to initialize it in your project. Add the following code to your main script:

using EcoTrack;

public class EcoTrackInitializer : MonoBehaviour
{
    void Start()
    {
        EcoTrackManager.Initialize("YOUR_API_KEY");
    }
}

Configuration

Configure the SDK according to your needs. You can set various parameters like data update intervals, tracking preferences, and more.

EcoTrackManager.SetUpdateInterval(60); // Update every 60 seconds
EcoTrackManager.EnableCarbonTracking(true);
EcoTrackManager.EnableEnergyTracking(true);

Features

Carbon Emission Tracking

Track carbon emissions generated by different activities in your application. Use the following API to log emissions:

EcoTrackManager.LogCarbonEmission(activity: "transport", amount: 50.5);

Renewable Energy Tracking

Monitor the usage of renewable energy sources in your application. Log energy usage with the following code:

EcoTrackManager.LogEnergyUsage(source: "solar", amount: 120.0);

Sustainability Reports

Generate sustainability reports based on the tracked data. You can customize the report parameters as needed:

SustainabilityReport report = EcoTrackManager.GenerateReport(startDate, endDate);
report.SaveAsPDF("sustainability_report.pdf");

API Reference

EcoTrackManager

Initialize

public static void Initialize(string apiKey)

Initializes the EcoTrack SDK with your API key.

SetUpdateInterval

public static void SetUpdateInterval(int seconds)

Sets the interval for data updates.

EnableCarbonTracking

public static void EnableCarbonTracking(bool enable)

Enables or disables carbon tracking.

LogCarbonEmission

public static void LogCarbonEmission(string activity, double amount)

Logs the amount of carbon emissions for a specific activity.

EnableEnergyTracking

public static void EnableEnergyTracking(bool enable)

Enables or disables renewable energy tracking.

LogEnergyUsage

public static void LogEnergyUsage(string source, double amount)

Logs the amount of energy used from a specific source.

GenerateReport

public static SustainabilityReport GenerateReport(DateTime startDate, DateTime endDate)

Generates a sustainability report for the specified date range.

Support

For any issues or questions, please visit our or contact us at support@ecotrack.com.

official website
support page