Farmbot-Web-App/frontend/devices/components/fbos_settings/fbos_details.tsx

305 lines
11 KiB
TypeScript

import * as React from "react";
import { Saucer, FBSelect } from "../../../ui";
import { updateConfig } from "../../actions";
import { last, isNumber, isString } from "lodash";
import { Content } from "../../../constants";
import { FbosDetailsProps } from "./interfaces";
import { SourceFbosConfig } from "../../interfaces";
import { ConfigurationName } from "farmbot";
import { t } from "../../../i18next_wrapper";
import { LastSeen } from "./last_seen_row";
import { Popover } from "@blueprintjs/core";
import moment from "moment";
import { timeFormatString } from "../../../util";
import { TimeSettings } from "../../../interfaces";
import { StringConfigKey } from "farmbot/dist/resources/configs/fbos";
import { boardType, FIRMWARE_CHOICES_DDI } from "../firmware_hardware_support";
import { ExternalUrl, FarmBotRepo } from "../../../external_urls";
/** Return an indicator color for the given temperature (C). */
export const colorFromTemp = (temp: number | undefined): string => {
if (!temp) {
return "gray";
}
if (temp < 0) {
return "lightblue";
} else if (temp < 10) {
return "blue";
} else if (temp > 75) {
return "red";
} else if (temp > 60) {
return "yellow";
} else {
return "green";
}
};
interface ChipTemperatureDisplayProps {
chip?: string;
temperature: number | undefined;
}
/** RPI CPU temperature display row: label, temperature, indicator. */
export function ChipTemperatureDisplay(
{ chip, temperature }: ChipTemperatureDisplayProps,
): JSX.Element {
return <div className="chip-temp-display">
<p>
<b>{chip && chip.toUpperCase()} {t("CPU temperature")}: </b>
{temperature ? <span>{temperature}&deg;C</span> : t("unknown")}
</p>
<Saucer color={colorFromTemp(temperature)} className={"small-inline"} />
</div>;
}
interface WiFiStrengthDisplayProps {
wifiStrength: number | undefined;
wifiStrengthPercent?: number | undefined;
extraInfo?: boolean;
}
/** WiFi signal strength display row: label, strength, indicator. */
export function WiFiStrengthDisplay(
{ wifiStrength, wifiStrengthPercent, extraInfo }: WiFiStrengthDisplayProps,
): JSX.Element {
const percent = wifiStrength
? Math.round(-0.0154 * wifiStrength ** 2 - 0.4 * wifiStrength + 98)
: 0;
const dbString = `${wifiStrength || 0}dBm`;
const percentString = `${wifiStrengthPercent || percent}%`;
const numberDisplay =
extraInfo ? `${percentString} (${dbString})` : percentString;
return <div className="wifi-strength-display">
<p>
<b>{t("WiFi strength")}: </b>
{wifiStrength ? numberDisplay : "N/A"}
</p>
{wifiStrength &&
<div className="percent-bar">
<div
className="percent-bar-fill"
style={{ width: percentString }}
title={dbString} />
</div>}
</div>;
}
/** Available throttle info. */
export enum ThrottleType {
UnderVoltage = "UnderVoltage",
ArmFrequencyCapped = "ArmFrequencyCapped",
Throttled = "Throttled",
SoftTempLimit = "SoftTempLimit",
}
/** Bit positions for throttle flags. */
const THROTTLE_BIT_LOOKUP:
Record<ThrottleType, Record<"active" | "occurred", number>> = {
[ThrottleType.UnderVoltage]: { active: 0, occurred: 16 },
[ThrottleType.ArmFrequencyCapped]: { active: 1, occurred: 17 },
[ThrottleType.Throttled]: { active: 2, occurred: 18 },
[ThrottleType.SoftTempLimit]: { active: 3, occurred: 19 },
};
/** Return a color based on throttle flag states. */
export const colorFromThrottle =
(throttled: string, throttleType: ThrottleType) => {
const throttleCode = parseInt(throttled, 16);
const bit = THROTTLE_BIT_LOOKUP[throttleType];
// tslint:disable-next-line:no-bitwise
const active = throttleCode & (1 << bit.active);
// tslint:disable-next-line:no-bitwise
const occurred = throttleCode & (1 << bit.occurred);
if (active) {
return "red";
} else if (occurred) {
return "yellow";
} else {
return "green";
}
};
const THROTTLE_COLOR_KEY = () => ({
red: t("active"),
yellow: t("occurred"),
green: t("ok")
});
interface ThrottleIndicatorProps {
throttleDataString: string;
throttleType: ThrottleType;
}
/** Saucer with color and title indicating throttle state. */
const ThrottleIndicator = (props: ThrottleIndicatorProps) => {
const { throttleDataString, throttleType } = props;
const throttleColor = colorFromThrottle(throttleDataString, throttleType);
return <Saucer className={"small-inline"}
title={THROTTLE_COLOR_KEY()[throttleColor]}
color={throttleColor} />;
};
/** Visual representation of throttle state. */
const ThrottleDisplay = (dataString: string) =>
<div className="throttle-display">
{Object.keys(THROTTLE_BIT_LOOKUP).map((key: ThrottleType) =>
<div className="throttle-row" key={key}>
<ThrottleIndicator throttleDataString={dataString} throttleType={key} />
<p>{key}</p>
</div>)}
</div>;
interface VoltageDisplayProps {
chip?: string;
throttled: string | undefined;
}
/** RPI throttle state display row: label, indicator. */
export const VoltageDisplay = ({ chip, throttled }: VoltageDisplayProps) =>
throttled
? <div className="voltage-display">
<p>
<b>{chip && chip.toUpperCase()} {t("Voltage")}: </b>
</p>
<Popover usePortal={false}>
<ThrottleIndicator
throttleDataString={throttled}
throttleType={ThrottleType.UnderVoltage} />
{ThrottleDisplay(throttled)}
</Popover>
</div> : <div className="voltage-display" />;
/** Get the first 8 characters of a commit. */
const shortenCommit = (longCommit: string) => (longCommit || "").slice(0, 8);
interface CommitDisplayProps {
title: string;
repo: FarmBotRepo;
commit: string;
}
/** GitHub commit display row: label, commit link. */
const CommitDisplay = (
{ title, repo, commit }: CommitDisplayProps,
): JSX.Element => {
const shortCommit = shortenCommit(commit);
return <p>
<b>{title}: </b>
{shortCommit === "---"
? shortCommit
: <a
href={`${ExternalUrl.gitHubFarmBot}/${repo}/tree/${shortCommit}`}
target="_blank">
{shortCommit}
</a>}
</p>;
};
interface UptimeDisplayProps {
uptime_sec: number;
}
/** FBOS uptime display row: label and uptime in relevant unit. */
const UptimeDisplay = ({ uptime_sec }: UptimeDisplayProps): JSX.Element => {
const convertUptime = (seconds: number) => {
if (seconds >= 172800) {
return `${Math.round(seconds / 86400)} ${t("days")}`;
} else if (seconds >= 7200) {
return `${Math.round(seconds / 3600)} ${t("hours")}`;
} else if (seconds >= 120) {
return `${Math.round(seconds / 60)} ${t("minutes")}`;
} else {
return `${seconds} ${t("seconds")}`;
}
};
return <p><b>{t("Uptime")}: </b>{convertUptime(uptime_sec)}</p>;
};
export interface BetaReleaseOptInButtonProps {
dispatch: Function;
sourceFbosConfig: SourceFbosConfig;
}
/** Label and toggle button for opting in to FBOS beta releases. */
export const BetaReleaseOptIn = (
{ dispatch, sourceFbosConfig }: BetaReleaseOptInButtonProps,
): JSX.Element => {
const betaOptIn = sourceFbosConfig("update_channel" as ConfigurationName).value;
return <fieldset className={"os-release-channel"}>
<label>
{t("OS release channel")}
</label>
<FBSelect
selectedItem={{ label: t("" + betaOptIn), value: "" + betaOptIn }}
onChange={ddi =>
(ddi.value == "stable" || confirm(Content.OS_BETA_RELEASES)) &&
dispatch(updateConfig({ ["update_channel" as StringConfigKey]: ddi.value }))}
list={[
{ label: t("stable"), value: "stable" },
{ label: t("beta"), value: "beta" },
{ label: t("staging"), value: "staging" },
{ label: t("qa"), value: "qa" },
]} />
</fieldset>;
};
/** Format datetime string for display. */
const reformatDatetime = (datetime: string, timeSettings: TimeSettings) =>
moment(datetime)
.utcOffset(timeSettings.utcOffset)
.format(`MMMM D, ${timeFormatString(timeSettings)}`);
const reformatFwVersion = (firmwareVersion: string | undefined): string => {
const version = firmwareVersion ?
firmwareVersion.split(".").slice(0, 3).join(".") : "none";
const board = FIRMWARE_CHOICES_DDI[boardType(firmwareVersion)]?.label || "";
return version == "none" ? "---" : `${version} ${board}`;
};
/** Current technical information about FarmBot OS running on the device. */
export function FbosDetails(props: FbosDetailsProps) {
const {
env, commit, target, node_name, firmware_version, firmware_commit,
soc_temp, wifi_level, uptime, memory_usage, disk_usage, throttled,
wifi_level_percent, cpu_usage, private_ip,
} = props.botInfoSettings;
const { last_ota, last_ota_checkup, fbos_version } = props.deviceAccount.body;
const infoFwCommit = firmware_version?.includes(".") ? firmware_commit : "---";
const firmwareCommit = firmware_version?.split("-")[1] || infoFwCommit;
return <div className={"farmbot-os-details"}>
<LastSeen
dispatch={props.dispatch}
botToMqttLastSeen={props.botToMqttLastSeen}
timeSettings={props.timeSettings}
device={props.deviceAccount} />
<p><b>{t("Version last seen")}: </b>{fbos_version}</p>
<p><b>{t("Environment")}: </b>{env}</p>
<CommitDisplay title={t("Commit")}
repo={FarmBotRepo.FarmBotOS} commit={commit} />
<p><b>{t("Target")}: </b>{target}</p>
<p><b>{t("Node name")}: </b>{last((node_name || "").split("@"))}</p>
<p><b>{t("Device ID")}: </b>{props.deviceAccount.body.id}</p>
{isString(private_ip) && <p><b>{t("Local IP address")}: </b>{private_ip}</p>}
<p><b>{t("Firmware")}: </b>{reformatFwVersion(firmware_version)}</p>
<CommitDisplay title={t("Firmware commit")}
repo={FarmBotRepo.FarmBotArduinoFirmware} commit={firmwareCommit} />
<p><b>{t("Firmware code")}: </b>{firmware_version}</p>
{isNumber(uptime) && <UptimeDisplay uptime_sec={uptime} />}
{isNumber(memory_usage) &&
<p><b>{t("Memory usage")}: </b>{memory_usage}MB</p>}
{isNumber(disk_usage) && <p><b>{t("Disk usage")}: </b>{disk_usage}%</p>}
{isNumber(cpu_usage) && <p><b>{t("CPU usage")}: </b>{cpu_usage}%</p>}
<ChipTemperatureDisplay chip={target} temperature={soc_temp} />
<WiFiStrengthDisplay extraInfo={true}
wifiStrength={wifi_level} wifiStrengthPercent={wifi_level_percent} />
<VoltageDisplay chip={target} throttled={throttled} />
<BetaReleaseOptIn
dispatch={props.dispatch} sourceFbosConfig={props.sourceFbosConfig} />
{last_ota_checkup && <p><b>{t("Last checked for updates")}: </b>
{reformatDatetime(last_ota_checkup, props.timeSettings)}</p>}
{last_ota && <p><b>{t("Last updated")}: </b>
{reformatDatetime(last_ota, props.timeSettings)}</p>}
</div>;
}