Merge pull request #442 from OpenDTU-App/423-handle-api-change-from-opendtu-project

Author: CommanderRedYT

src/api/opendtuapi.ts

@@ -1234,6 +1234,8 @@ class OpenDtuApi {
       parsed,
     });
 
+    console.log('setLimitConfig', 'response', res, parsed, config);
+
     return res.status === 200 && parsed.type === 'success';
   }
 

src/components/modals/LimitConfigModal.tsx

@@ -14,21 +14,25 @@ import {
 import type { TFunction } from 'i18next';
 
 import type { LimitConfig } from '@/types/opendtu/control';
-import { SetStatus } from '@/types/opendtu/control';
+import { LegacyLimitType, SetStatus } from '@/types/opendtu/control';
 
 import type { ExtendableModalProps } from '@/components/BaseModal';
 import BaseModal from '@/components/BaseModal';
 import StyledTextInput from '@/components/styled/StyledTextInput';
 
+import useDtuState from '@/hooks/useDtuState';
 import useInverterLimits from '@/hooks/useInverterLimits';
 
+import { convertLimitTypeToCorrectEnum } from '@/utils/legacy';
+
 import { useApi } from '@/api/ApiHandler';
+import type { OpenDtuFirmwareVersion } from '@/constants';
 
 export interface LimitConfigModalProps extends ExtendableModalProps {
   inverterSerial: string;
 }
 
-export type LimitType = 'absolute' | 'relative';
+export type LimitConfigType = 'absolute' | 'relative';
 
 const buttonColors: Record<
   'permanent' | 'temporary',
@@ -72,7 +76,11 @@ const LimitConfigModal: FC<LimitConfigModalProps> = ({
 
   const limitConfig = useInverterLimits(inverterSerial, state => state);
 
-  const [limitType, setLimitType] = useState<LimitType>('absolute');
+  const currentFirmwareVersion = useDtuState(
+    state => state?.systemStatus?.git_hash,
+  );
+
+  const [limitType, setLimitType] = useState<LimitConfigType>('absolute');
   const [limitValue, setLimitValue] = useState<string>('0');
 
   const api = useApi();
@@ -107,8 +115,21 @@ const LimitConfigModal: FC<LimitConfigModalProps> = ({
         return;
       }
 
+      if (typeof currentFirmwareVersion !== 'string') {
+        setError(t('limitStatus.error'));
+        return;
+      }
+
       const limitConfig: LimitConfig = {
-        limit_type: (permanent ? 256 : 0) + (limitType === 'relative' ? 1 : 0),
+        limit_type: convertLimitTypeToCorrectEnum(
+          (permanent
+            ? LegacyLimitType.PermanentAbsolute
+            : LegacyLimitType.TemporaryAbsolute) +
+            (limitType === 'relative'
+              ? LegacyLimitType.TemporaryRelative
+              : LegacyLimitType.TemporaryAbsolute),
+          currentFirmwareVersion as OpenDtuFirmwareVersion,
+        ),
         limit_value: numberValue,
         serial: inverterSerial,
       };
@@ -127,6 +148,7 @@ const LimitConfigModal: FC<LimitConfigModalProps> = ({
       }
     },
     [
+      currentFirmwareVersion,
       api,
       inverterLimitConfig,
       inverterSerial,
@@ -244,7 +266,7 @@ const LimitConfigModal: FC<LimitConfigModalProps> = ({
           }}
         >
           <RadioButton.Group
-            onValueChange={value => setLimitType(value as LimitType)}
+            onValueChange={value => setLimitType(value as LimitConfigType)}
             value={limitType}
           >
             <RadioButton.Item

src/constants.ts

@@ -29,9 +29,17 @@ export const spacing = 8;
 
 export const defaultUser = 'admin';
 
-export const minimumOpenDtuFirmwareVersion = 'v23.11.16';
+export type OpenDtuFirmwareVersion = `v${number}.${number}.${number}`;
 
-export const maximumTestedOpenDtuFirmwareVersion = 'v24.4.12';
+export const minimumOpenDtuFirmwareVersion: OpenDtuFirmwareVersion =
+  'v23.11.16';
+
+export const maximumTestedOpenDtuFirmwareVersion: OpenDtuFirmwareVersion =
+  'v24.4.12';
+
+export const featureFlags: Record<string, OpenDtuFirmwareVersion> = {
+  apiLimitConfigEnumChange: 'v25.9.11', // https://github.com/tbnobody/OpenDTU/commit/8cab3335f348d9ec5221ebf01634c593e3a4213b
+};
 
 export const weblateUrl =
   'https://weblate.commanderred.xyz/engage/opendtu-react-native/';

src/types/opendtu/control.ts

@@ -28,15 +28,23 @@ export interface LimitStatusItem {
 
 export type LimitStatusData = Record<InverterSerial, LimitStatusItem>;
 
-export enum LimitType {
+export enum LegacyLimitType {
   TemporaryAbsolute = 0,
   TemporaryRelative = 1,
   PermanentAbsolute = 256,
   PermanentRelative = 257,
 }
 
+export enum LimitType {
+  AbsolutNonPersistent,
+  RelativNonPersistent,
+  AbsolutPersistent,
+  RelativPersistent,
+  PowerLimitControl_Max,
+}
+
 export interface LimitConfig {
   serial: InverterSerial;
   limit_value: number;
-  limit_type: LimitType;
+  limit_type: LimitType | LegacyLimitType; // depends on featureFlags.apiLimitConfigEnumChange
 }

src/utils/legacy.ts

@@ -0,0 +1,53 @@
+import { compare } from 'compare-versions';
+
+import { LegacyLimitType, LimitType } from '@/types/opendtu/control';
+
+import type { OpenDtuFirmwareVersion } from '@/constants';
+
+const legacyToNewlimitTypeMap = {
+  [LegacyLimitType.TemporaryAbsolute]: LimitType.AbsolutNonPersistent,
+  [LegacyLimitType.TemporaryRelative]: LimitType.RelativNonPersistent,
+  [LegacyLimitType.PermanentAbsolute]: LimitType.AbsolutPersistent,
+  [LegacyLimitType.PermanentRelative]: LimitType.RelativPersistent,
+} as const;
+
+const newToLegacyLimitTypeMap = {
+  [LimitType.AbsolutNonPersistent]: LegacyLimitType.TemporaryAbsolute,
+  [LimitType.RelativNonPersistent]: LegacyLimitType.TemporaryRelative,
+  [LimitType.AbsolutPersistent]: LegacyLimitType.PermanentAbsolute,
+  [LimitType.RelativPersistent]: LegacyLimitType.PermanentRelative,
+  [LimitType.PowerLimitControl_Max]: LegacyLimitType.TemporaryAbsolute,
+} as const;
+
+export const getCorrectLimitType = (
+  limitTypeFromApi: LimitType | LegacyLimitType,
+  firmwareVersion: OpenDtuFirmwareVersion,
+): LimitType => {
+  // if firmware version is >= v25.9.11, directly return the limit type from API. if not, map the legacy limit type to the new limit type
+  if (
+    compare(firmwareVersion, 'v25.9.11', '>=') // featureFlags.apiLimitConfigEnumChange
+  ) {
+    return limitTypeFromApi as LimitType;
+  }
+
+  return legacyToNewlimitTypeMap[
+    limitTypeFromApi as LegacyLimitType
+  ] as LimitType;
+};
+
+export const convertLimitTypeToCorrectEnum = (
+  limitType: LegacyLimitType,
+  firmwareVersion: OpenDtuFirmwareVersion,
+): LimitType | LegacyLimitType => {
+  // if firmware version is >= v25.9.11, directly return the limit type. if not, map the new limit type to the legacy limit type
+
+  if (
+    compare(firmwareVersion, 'v25.9.11', '>=') // featureFlags.apiLimitConfigEnumChange
+  ) {
+    return newToLegacyLimitTypeMap[
+      limitType as unknown as LimitType
+    ] as LegacyLimitType;
+  }
+
+  return limitType;
+};