Skip to content
newmatikPublic

Repository files navigation

EsoCore

Sponsor

EsoCore (Edge Sensor Observation, Control, Operations, Reliability Engine) is an open-source industrial IoT platform for monitoring factory machinery and equipment. It spans the full stack from PCB hardware and embedded firmware to a Django REST API backend and a Nuxt.js user portal.

Status: in development. Newmatik builds it for monitoring machines on factory floors. The documentation website is live at www.esocore.com (Cloudflare Workers); the API and the portal have no production deployment yet and run locally only.

Coding agents: AGENTS.md has the conventions, local caveats and CI gates.

Repository Structure

esocore/
  server/       Django REST API backend
  portal/       Nuxt.js user portal (dashboard, devices, alerts)
  website/      Public documentation site (static Nuxt.js, Cloudflare Workers)
  firmware/     Embedded C firmware for Edge (STM32H7) and sensors (STM32G0)
  hardware/     PCB designs (Altium), BOMs, Gerber, STEP, schematics
  tools/        Utility scripts (BOM sync, STEP linter)
  assets/       Shared icons and images

Tech Stack

Layer Technology
Backend Python 3.11–3.13, Django 5, Django REST Framework, Poetry
Portal TypeScript, Nuxt 4 (Vue 3), Nuxt UI, Tailwind CSS 4, Pinia
Website TypeScript, Nuxt 4 (Vue 3), static generation, Cloudflare
Firmware C (C11), STM32H7 / STM32G0, ARM GCC, GNU Make
Hardware Altium Designer, 4-layer FR4 PCBs

Prerequisites

  • Python 3.11 to 3.13 and Poetry for the server (CI uses 3.11)
  • Node 24 (24.11 or newer; CI and the .nvmrc files use 24.22.3) and pnpm 10 (as in CI) for the portal and website
  • ARM GCC (arm-none-eabi-gcc) and GNU Make for the firmware

Getting Started

Server (Django REST API)

cd server
poetry install
poetry run python manage.py migrate
poetry run python manage.py createsuperuser
poetry run python manage.py runserver

The API is served at http://localhost:8000/api/ with Swagger docs at http://localhost:8000/api/docs/.

See server/README.md for full setup, authentication, and deployment details.

Portal (Nuxt.js)

cd portal
pnpm install
pnpm run dev

The portal runs at http://localhost:3080.

See portal/README.md for configuration and branding details.

Website (Documentation)

cd website
pnpm install
pnpm run dev

The website runs at http://localhost:3081.

To generate the static site for production:

pnpm run generate

See website/README.md for deployment instructions.

Firmware

cd firmware
make all            # Build Edge + all sensors
make edge-objects   # Compile the Edge sources without linking
make sensor-objects # Compile the sensor module sources without linking
make edge           # Build Edge only
make vibration      # Build a single sensor target
make help           # List all available targets

Requires the ARM GCC toolchain. make edge-objects and make sensor-objects compile every Edge and sensor module source file; the targets that link do not build yet (#128). make test runs the host unit tests with the local C compiler. See firmware/README.md for architecture and protocol details.

Checks

The server, portal, website, tools and firmware each have a CI workflow in .github/workflows/ that runs on pull requests to main (hardware/ has none; the firmware workflow runs the host unit tests and compiles the Edge sources, it does not link the target firmware). The commands for these parts are listed in AGENTS.md; run the ones for the part you changed before pushing.

Hardware

PCB designs, schematics, and BOMs are organized under hardware/:

  • hardware/edge/ -- Edge device (STM32H747, dual Ethernet, RS-485, WiFi, IEPE inputs, safety I/O)
  • hardware/sensors/ -- RS-485 sensor modules
    • vibration, acoustic, current, air quality, light, oil quality, pressure, temperature spot, proximity position
  • hardware/cables/ -- Cable assemblies

CAD files are in each device's altium/ folder (open the .PcbDoc projects with Altium Designer). See hardware/README.md and individual sensor READMEs for specifications.

BOM Management

Canonical BOM CSVs live in each device folder under hardware/. The website reads CSVs from website/public/bom/ for public rendering. After editing any BOM in hardware/, run:

python3 tools/sync_bom_data.py

Protocols

The Edge device supports industrial fieldbus protocols:

  • Modbus RTU (RS-485, isolated) and Modbus TCP (Ethernet)
  • PROFIBUS DP (DB-9, switchable termination)
  • PROFINET Device (over Ethernet)

Documentation

Open Source

Source code: github.com/newmatik/EsoCore

Legal

Copyright 2026 Newmatik. All rights reserved. Licensed under the Apache License, Version 2.0. See website/content/license.md for details.

Releases

Sponsor this project

Used by

Contributors

Languages