Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
818 changes: 805 additions & 13 deletions package-lock.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"jsdom": "^25.0.1",
"loglevel": "^1.9.2",
"prettier": "^3.3.3",
"react-gauge-component": "^1.2.64",
"react-id-generator": "^3.0.2",
"react-test-renderer": "^18.3.1",
"react-tiny-popover": "^8.1.2",
Expand Down
7 changes: 6 additions & 1 deletion src/ui/widgets/EmbeddedDisplay/bobParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ const BOB_WIDGET_MAPPING: { [key: string]: any } = {
rectangle: "shape",
tank: "tank",
thermometer: "thermometer",
meter: "meter",
choice: "choicebutton",
scaledslider: "slidecontrol",
symbol: "symbol"
Expand Down Expand Up @@ -85,6 +86,7 @@ export const WIDGET_DEFAULT_SIZES: { [key: string]: [number, number] } = {
rectangle: [100, 20],
tank: [150, 200],
thermometer: [40, 160],
meter: [240, 120],
scaledslider: [400, 55],
symbol: [100, 100]
};
Expand Down Expand Up @@ -381,6 +383,7 @@ export function parseBob(
symbols: ["symbols", bobParseSymbols],
initialIndex: ["initial_index", bobParseNumber],
showIndex: ["show_index", opiParseBoolean],
showValue: ["show_value", opiParseBoolean],
fallbackSymbol: ["fallback_symbol", opiParseString],
rotation: ["rotation", bobParseNumber],
styleOpt: ["style", bobParseNumber],
Expand All @@ -401,7 +404,9 @@ export function parseBob(
majorTickStepHint: ["major_tick_step_hint", bobParseNumber],
maximum: ["maximum", bobParseNumber],
minimum: ["minimum", bobParseNumber],
emptyColor: ["empty_color", opiParseColor]
format: ["format", bobParseNumber],
emptyColor: ["empty_color", opiParseColor],
needleColor: ["needle_color", opiParseColor]
};

const complexParsers = {
Expand Down
7 changes: 6 additions & 1 deletion src/ui/widgets/EmbeddedDisplay/opiParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ const OPI_WIDGET_MAPPING: { [key: string]: any } = {
"org.csstudio.opibuilder.widgets.progressbar": "progressbar",
"org.csstudio.opibuilder.widgets.tank": "tank",
"org.csstudio.opibuilder.widgets.thermometer": "thermometer",
"org.csstudio.opibuilder.widgets.tmeter": "meter",
"org.csstudio.opibuilder.widgets.LED": "led",
"org.csstudio.opibuilder.widgets.Image": "image",
"org.csstudio.opibuilder.widgets.edm.symbolwidget": "pngsymbol",
Expand Down Expand Up @@ -642,11 +643,13 @@ export const OPI_SIMPLE_PARSERS: ParserDict = {
onColor: ["on_color", opiParseColor],
offColor: ["off_color", opiParseColor],
fillColor: ["fill_color", opiParseColor],
needleColor: ["needle_color", opiParseColor],
precision: ["precision", opiParseNumber],
formatType: ["format_type", opiParseFormatType],
precisionFromPv: ["precision_from_pv", opiParseBoolean],
visible: ["visible", opiParseBoolean],
showUnits: ["show_units", opiParseBoolean],
showValue: ["show_value_label", opiParseBoolean],
scaleVisible: ["scale_visible", opiParseBoolean],
transparent: ["transparent", opiParseBoolean],
horizontal: ["horizontal", opiParseBoolean],
Expand Down Expand Up @@ -713,7 +716,9 @@ export const OPI_SIMPLE_PARSERS: ParserDict = {
selectedColor: ["selected_color", opiParseColor],
enabled: ["enabled", opiParseBoolean],
resize: ["resize_behaviour", opiParseResizing],
labelsFromPv: ["labels_from_pv", opiParseBoolean]
labelsFromPv: ["labels_from_pv", opiParseBoolean],
limitsFromPv: ["limits_from_pv", opiParseBoolean],
format: ["format_type", opiParseNumber]
};

/**
Expand Down
187 changes: 187 additions & 0 deletions src/ui/widgets/Meter/meter.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
import { describe, it, expect, vi, beforeEach } from "vitest";
import React from "react";
import { render, screen } from "@testing-library/react";
import { MeterComponent } from "./meter";
import { Color } from "../../../types/color";
import { NumberFormatEnum } from "./meterUtilities";
import * as meterUtilities from "./meterUtilities";
import { DType, Font } from "../../../types";

vi.mock("react-gauge-component", () => ({
GaugeComponent: vi.fn(
({ value, minValue, maxValue, pointer, arc, labels }) => (
<div
data-testid="gauge-component"
data-value={value}
data-min={minValue}
data-max={maxValue}
>
<div data-testid="pointer" data-color={pointer.color}></div>
<div data-testid="arc" data-subarcs={JSON.stringify(arc.subArcs)}></div>
<div
data-testid="value-label"
data-hide={labels.valueLabel.hide}
data-fontFamily={labels.valueLabel.style.fontFamily}
></div>
</div>
)
)
}));

vi.mock("./meterUtilities", async () => {
const actual = await vi.importActual("./meterUtilities");
return {
...actual,
formatValue: vi.fn(
(value, format, precision, units, showUnits) => () => `${value}`
),
buildSubArcs: vi.fn(() => [{ color: "red", start: 0, end: 100 }]),
createIntervals: vi.fn(() => [0, 25, 50, 75, 100]),
convertInfAndNanToUndefined: vi.fn(val => val)
};
});

describe("MeterComponent", () => {
const defaultProps = {
connected: false,
readonly: true,
pvName: "PV:Test",
value: {
getDoubleValue: () => 50,
display: {
units: "kW",
controlRange: { min: 0, max: 100 },
alarmRange: { min: 80, max: 100 },
warningRange: { min: 60, max: 80 }
}
} as Partial<DType> as DType,
foregroundColor: Color.fromRgba(0, 0, 0, 1),
needleColor: Color.fromRgba(255, 5, 7, 1),
backgroundColor: Color.fromRgba(250, 250, 250, 1)
};

beforeEach(() => {
vi.clearAllMocks();
});

it("renders with default props", () => {
render(<MeterComponent {...defaultProps} />);

const gaugeComponent = screen.getByTestId("gauge-component");
expect(gaugeComponent).toBeInTheDocument();
expect(gaugeComponent.getAttribute("data-value")).toBe("50");
expect(gaugeComponent.getAttribute("data-min")).toBe("0");
expect(gaugeComponent.getAttribute("data-max")).toBe("100");
});

it("uses custom min/max values when limitsFromPv is false", () => {
render(
<MeterComponent
{...defaultProps}
minimum={-50}
maximum={150}
limitsFromPv={false}
/>
);

const gaugeComponent = screen.getByTestId("gauge-component");
expect(gaugeComponent.getAttribute("data-min")).toBe("-50");
expect(gaugeComponent.getAttribute("data-max")).toBe("150");
});

it("uses PV limits when limitsFromPv is true", () => {
render(
<MeterComponent
{...defaultProps}
minimum={-50}
maximum={150}
limitsFromPv={true}
/>
);

const gaugeComponent = screen.getByTestId("gauge-component");
expect(gaugeComponent.getAttribute("data-min")).toBe("0"); // From controlRange.min
expect(gaugeComponent.getAttribute("data-max")).toBe("100"); // From controlRange.max
});

it("uses transparent background when transparent is true", () => {
render(<MeterComponent {...defaultProps} transparent={true} />);

const box = screen.getByTestId("gauge-component").parentElement;
expect(box).toHaveStyle("background-color: rgba(0, 0, 0, 0)");
});

it("hides value when showValue is false", () => {
render(<MeterComponent {...defaultProps} showValue={false} />);

const valueLabel = screen.getByTestId("value-label");
expect(valueLabel.getAttribute("data-hide")).toBe("true");
});

it("calls formatValue with correct parameters", () => {
render(
<MeterComponent
{...defaultProps}
format={NumberFormatEnum.Exponential}
precision={2}
showUnits={true}
/>
);

expect(meterUtilities.formatValue).toHaveBeenCalledWith(
50,
NumberFormatEnum.Exponential,
2,
"kW",
true
);
});

it("calls buildSubArcs with correct parameters", () => {
render(<MeterComponent {...defaultProps} />);

expect(meterUtilities.buildSubArcs).toHaveBeenCalledWith(
"rgba(0,0,0,1)",
0,
100,
80,
60,
80,
100
);
});

it("handles missing PV value gracefully", () => {
render(<MeterComponent {...defaultProps} value={undefined} />);

const gaugeComponent = screen.getByTestId("gauge-component");
expect(gaugeComponent.getAttribute("data-value")).toBe("0");
});

it("scales width correctly based on height/width ratio", () => {
render(<MeterComponent {...defaultProps} height={100} width={300} />);

const box = screen.getByTestId("gauge-component").parentElement;
expect(box).toHaveStyle("width: 190px"); // 1.9 * height
});

it("uses default width when width/height ratio is less than 1.9", () => {
render(<MeterComponent {...defaultProps} height={100} width={150} />);

const box = screen.getByTestId("gauge-component").parentElement;
expect(box).toHaveStyle("width: 150px"); // original width
});

it("applies font styles correctly", () => {
const font = {
css: () => ({ fontFamily: "Arial" })
} as Partial<Font> as Font;

render(<MeterComponent {...defaultProps} font={font} />);

const valueLabel = screen.getByTestId("value-label");

const labelStyle = valueLabel.getAttribute("data-fontFamily");
expect(labelStyle).toBe("Arial");
});
});
Loading
Loading