Merge branch 'release/0.9.1'

README.md

@@ -7,7 +7,7 @@ A progressive web-app to flash your BLHELI_S capable ESC's directly from the web
 
 > The latest state of the master branch can be [viewed in the browser](https://esc-configurator.com)
 
-This is basically a complete re-write of the original BLHELI_S configurator. Some bits and pieces have been re-used - mainly the ones concerning the actual flashing part.
+This project is basically a re-write and clean up of the original [Blheli configurator](https://github.com/blheli-configurator/blheli-configurator). Some bits and pieces have been re-used - mainly the ones concerning the actual flashing part.
 
 I did this since I was interested in having this as an web app, but also because the original BLHELI_S configurator code was too much for me to re-factor and I thought I might be able to re-write it in the same amount of time.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "esc-configurator",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "private": true,
   "dependencies": {
     "@palmabit/react-cookie-law": "^0.6.2",

public/index.html

@@ -59,7 +59,7 @@
       #root:empty:after {
         margin: 60px auto;
         font-size: 10px;
-        position: relative;
+        position: absolute;
         text-indent: -9999em;
         border-top: 1.1em solid rgba(255, 255, 255, 0.2);
         border-right: 1.1em solid rgba(255, 255, 255, 0.2);

src/Components/Flash/Escs/Esc/index.jsx

@@ -25,16 +25,23 @@ function Esc({
   const settings = esc.individualSettings;
   const currentSettings = settings;
   const settingsDescriptions = esc.individualSettingsDescriptions;
-  const revision = settings ? `${settings.MAIN_REVISION}.${settings.SUB_REVISION}` : 'UNSUPPORTED';
+
+  let revision = 'Unsupported/Unrecognized';
+  if(settings.MAIN_REVISION !== undefined && settings.SUB_REVISION !== undefined) {
+    revision = `${settings.MAIN_REVISION}.${settings.SUB_REVISION}`;
+  }
 
   let make = '';
   if (esc.make) {
     make = `${esc.make}, `;
   }
 
-  let name = settings ? (settings.NAME).trim() : '';
-  if (name.length > 0) {
-    name = `, ${name}`;
+  let name = '';
+  if(settings.NAME) {
+    name = settings ? (settings.NAME).trim() : '';
+    if (name.length > 0) {
+      name = `, ${name}`;
+    }
   }
 
   let bootloader = '';

src/Components/Home/index.jsx

@@ -13,11 +13,21 @@ function Home() {
     return(
       <div className="column third_left text1">
         <div className="wrap">
-          <h2>
-            {t('homeDisclaimerHeader')}
-          </h2>
+          <div className="summary-section">
+            <h2>
+              {t('homeDisclaimerHeader')}
+            </h2>
+
+            <div dangerouslySetInnerHTML={{ __html: t('homeDisclamierText') }} />
+          </div>
+
+          <div className="summary-section">
+            <h2>
+              {t('homeAttributionHeader')}
+            </h2>
 
-          <div dangerouslySetInnerHTML={{ __html: t('homeDisclamierText') }} />
+            <div dangerouslySetInnerHTML={{ __html: t('homeAttributionText') }} />
+          </div>
         </div>
       </div>
     );
@@ -137,6 +147,14 @@ function Home() {
             </a>
           </div>
 
+          <div className="summary-section">
+            <h2>
+              {t('homeChinaHeader')}
+            </h2>
+
+            <div dangerouslySetInnerHTML={{ __html: t('homeChinaText') }} />
+          </div>
+
           <div className="summary-section">
             <h2>
               {t('homeContributionHeader')}

src/changelog.json

@@ -1,4 +1,12 @@
 [
+  {
+    "title": "0.9.1",
+    "items": [
+      "Add attribution to original project",
+      "Properly display ESCs, even if their settings can not be read",
+      "Link to chinese mirror"
+    ]
+  },
   {
     "title": "0.9.0",
     "items": [

src/settings.json

@@ -1,4 +1,4 @@
 {
-  "version": "0.9.0",
+  "version": "0.9.1",
   "corsProxy": "https://bubblesort.me/?"
 }

src/sources/Source.js

@@ -11,8 +11,8 @@ import {
 
 class Source {
   constructor(name, platform, versions, escs, eeprom, localVersions, localEscs, pwm) {
-    if(!name || !versions || !escs || !localVersions || !localEscs || !pwm) {
-      throw new Error("Parameters required: name, platform, versions, escs, eeprom, localVersions, localEscs");
+    if(!name || platform === undefined || !versions || !escs || !eeprom || !localVersions || !localEscs || !pwm) {
+      throw new Error("Parameters required: name, platform, versions, escs, eeprom, localVersions, localEscs, pwm");
     }
 
     this.name = name;

src/sources/__tests__/Source.test.js

@@ -0,0 +1,40 @@
+import {
+  Source
+} from '../Source';
+
+import {
+  blheliSource,
+} from '../index';
+
+test('Source without parameters', () => {
+  try {
+    const source = new Source();
+  } catch(e) {
+    expect(e).not.toBeNull();
+  }
+});
+
+test('blheliSource get versions', async() => {
+  let versions = await blheliSource.getVersions();
+  expect(versions).not.toBe({});
+});
+
+test('blheliSource get escs', async() => {
+  const escs = await blheliSource.getEscs();
+  expect(escs).not.toBe({});
+});
+
+test('blheliSource get platform', async() => {
+  const platform = await blheliSource.getPlatform();
+  expect(platform).toBe(0);
+});
+
+test('blheliSource get platform', async() => {
+  const name = await blheliSource.getName();
+  expect(name).toBe('Blheli');
+});
+
+test('blheliSource get platform', async() => {
+  const pwm = await blheliSource.getPwm();
+  expect(pwm.length).toBe(0);
+});

src/translations/en/common.json

@@ -87,5 +87,10 @@
   "masterSpeed": "Master Speed",
   "motorNr": "Motor {{index}}",
   "homeDiscordHeader": "Join us on Discord!",
-  "homeDiscordText": "If you have any questions or need a quick helping hand, join us on our Discord server:"
+  "homeDiscordText": "If you have any questions or need a quick helping hand, join us on our Discord server:",
+  "homeChinaHeader": "For our Chinese Visiotors",
+  "homeChinaText": "Tell your friends behind the great firewall of China, that they can reach us via a local <a href=\"https://esc-configurator.pitronic.top/\">mirror directly in China<a>.",
+  "melodyEditor": "Melody Editor",
+  "homeAttributionHeader": "Attribution",
+  "homeAttributionText": "This project was heavily inspired by the <a target=\"_blank\" href=\"https://github.com/blheli-configurator/blheli-configurator\">Blheli Configurator</a>. Most of the UI has been re-written from scratch but a lot of the low level stuff related to flashing and firmware handling have been re-used - so a big shout out to everyone involved in the original Blheli Configurator."
 }