PHPackages                             hellojb/foxess-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. hellojb/foxess-php

ActiveLibrary[API Development](/categories/api)

hellojb/foxess-php
==================

PHP SDK for the FoxESS Cloud API with Laravel support

03PHP

Since Jul 10Pushed 1mo agoCompare

[ Source](https://github.com/hellojb/foxess-php)[ Packagist](https://packagist.org/packages/hellojb/foxess-php)[ RSS](/packages/hellojb-foxess-php/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependenciesVersions (1)Used By (0)

hellojb/foxess-php
==================

[](#hellojbfoxess-php)

PHP SDK for the FoxESS Cloud Open API with Laravel support.

Features
--------

[](#features)

- OAuth 2.0 Authorization Code Grant authentication
- Automatic token refresh
- Real-time device data (battery SOC, solar generation, grid import/export, load statistics)
- Batch queries for multiple devices
- Typed DTOs with helper methods
- Laravel Service Provider, Facade, and config
- Rate limit exception handling

Requirements
------------

[](#requirements)

- PHP 8.2+
- GuzzleHTTP 7.0+

Installation
------------

[](#installation)

```
composer require hellojb/foxess-php
```

Standalone Usage
----------------

[](#standalone-usage)

```
use Hellojb\Foxess\FoxEss;
use Hellojb\Foxess\Auth\AccessToken;

$token = new AccessToken('your-access-token');

$client = new FoxEss([
    'base_url' => 'https://www.foxesscloud.com/',
    'token' => $token,
]);

$realTime = $client->realTimeData()->query(['YOUR_DEVICE_SN']);

foreach ($realTime as $data) {
    echo "SoC: {$data->soc()}%\n";
    echo "PV Power: {$data->pvPower()} kW\n";
    echo "Charging: " . ($data->isCharging() ? 'Yes' : 'No') . "\n";
}
```

Laravel Usage
-------------

[](#laravel-usage)

Publish the config:

```
php artisan vendor:publish --tag=foxess-config
```

Set `.env` variables:

```
FOXESS_CLIENT_ID=your-client-id
FOXESS_CLIENT_SECRET=your-client-secret
FOXESS_REDIRECT_URI=https://your-app.com/auth/foxess/callback
```

Use the Facade:

```
use Hellojb\Foxess\Laravel\FoxEssFacade as FoxEss;

$realTime = FoxEss::realTimeData()->query(['SN001']);
```

Real-Time Data Helpers
----------------------

[](#real-time-data-helpers)

The `RealTimeData` DTO provides convenient accessors:

MethodDescription`soc()`Battery state of charge (%)`pvPower()`Solar generation (kW)`loadsPower()`Home load (kW)`batteryPower()`Battery power (negative = charging, positive = discharging)`isCharging()`Is battery currently charging?`isDischarging()`Is battery currently discharging?`isImporting()`Is power being imported from grid?`isExporting()`Is power being exported to grid?License
-------

[](#license)

MIT

###  Health Score

20

—

LowBetter than 12% of packages

Maintenance60

Regular maintenance activity

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity11

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/3bc37582b9a81962c140bfae33d75dd16e17af9f6e8385f221e74fbbd18d0902?d=identicon)[johnblackmore](/maintainers/johnblackmore)

---

Top Contributors

[![johnblackmore](https://avatars.githubusercontent.com/u/4094712?v=4)](https://github.com/johnblackmore "johnblackmore (1 commits)")

### Embed Badge

![Health badge](/badges/hellojb-foxess-php/health.svg)

```
[![Health](https://phpackages.com/badges/hellojb-foxess-php/health.svg)](https://phpackages.com/packages/hellojb-foxess-php)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35816.5M7](/packages/exsyst-swagger)[lucasdotvin/laravel-soulbscription

A straightforward interface to handle subscriptions and features consumption.

709209.3k](/packages/lucasdotvin-laravel-soulbscription)[pimax/fb-messenger-php

Facebook Messenger Bot PHP API

313188.5k2](/packages/pimax-fb-messenger-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)