added new api endpoint

added new api endpoint `getBMPByID_v2`

Author: o0shojo0o

README.md

@@ -55,6 +55,9 @@ Install dependencies with `npm install` and run dev server with `npn run dev`.
 
 ## Changelog
 
+### 1.8.8 (2025-12-28)
+- (o0shojo0o) added new api endpoint `getBMPByID_v2` for better handling of animated bitmaps
+
 ### 1.8.7 (2024-10-07)
 
 - (o0shojo0o) add uuid to each request

libs/pixelItRepo.js

@@ -16,7 +16,7 @@ const connection = mysql.createPool({
 });
 
 async function getBMPByID(id) {
-    let result
+    let result;
     try {
         result = await connection.query(
             `select 
@@ -36,10 +36,10 @@ async function getBMPByID(id) {
                         where
                             a.id = ?`,
             id
-        )
+        );
         if (result[0][0]) {
-            result[0][0].animated = tools.mysqlToBool(result[0][0].animated)
-            return result[0][0]
+            result[0][0].animated = tools.mysqlToBool(result[0][0].animated);
+            return result[0][0];
         }
 
     } catch (error) {
@@ -48,6 +48,23 @@ async function getBMPByID(id) {
     }
 };
 
+async function getBMPByID_v2(id) {
+    let result;
+    try {
+        result = await getBMPByID(id);
+        if (result) {
+            if (result.animated == true) {
+                result.rgb565array = `[${result.rgb565array}]`;
+            }
+            return result;
+        }
+
+    } catch (error) {
+        log.error('getBMPByID_v2: {error}', { error: error })
+        return undefined
+    }
+};
+
 async function getBMPAll() {
     let result
     try {
@@ -229,6 +246,7 @@ async function getStatistics() {
 
 module.exports = {
     getBMPByID,
+    getBMPByID_v2,
     getBMPAll,
     getBMPNewst,
     saveTelemetry,

main.js

@@ -51,6 +51,30 @@ app.get('/api/GetBMPByID/:id', async (req, res) => {
     res.send(bmp);
 });
 
+app.get('/api/GetBMPByID_v2/:id', async (req, res) => {
+    const sourceIP = tools.getIPFromRequest(req);
+    const rawUrl = tools.getRawURLFromRequest(req);
+    const id = req.params.id;
+    const uuid = req.query.uuid || '';
+
+    if (tools.isNumeric(id) == false) {
+        log.warn('{apiPath}: {id} is not a valid ID!', { apiPath: 'GetBMPByID_v2', id, sourceIP, rawUrl, useragent: req.useragent, rateLimit: req.rateLimit, uuid: uuid, });
+        res.status(400).send('Not valid ID');
+        return;
+    }
+
+    const bmp = (await cache.getOrSet(`GetBMPByID_v2_${id}`, () => { return repo.getBMPByID(id) }, 0));
+
+    if (!bmp) {
+        log.warn('{apiPath}: BMP ID: {id} is not valide', { apiPath: 'GetBMPByID_v2', id: id, sourceIP, rawUrl, useragent: req.useragent, rateLimit: req.rateLimit, uuid: uuid, });
+        res.status(400).send(`BMP ID: ${id} is not valide`);
+        return;
+    }
+
+    log.info('{apiPath}: BMP with ID {id} and name {name} successfully delivered', { apiPath: 'GetBMPByID_v2', id: bmp.id, name: bmp.name, sourceIP, rawUrl, useragent: req.useragent, rateLimit: req.rateLimit, uuid: uuid, });
+    res.send(bmp);
+});
+
 app.get('/api/GetBMPNewst', async (req, res) => {
     const sourceIP = tools.getIPFromRequest(req);
     const rawUrl = tools.getRawURLFromRequest(req);