nixos/modules/services/video/photonvision.nix

   1 { config, pkgs, lib, ... }:
   2
   3 let
   4   cfg = config.services.photonvision;
   5 in
   6 {
   7   options = {
   8     services.photonvision = {
   9       enable = lib.mkEnableOption "PhotonVision";
  10
  11       package = lib.mkPackageOption pkgs "photonvision" {};
  12
  13       openFirewall = lib.mkOption {
  14         description = ''
  15           Whether to open the required ports in the firewall.
  16         '';
  17         default = false;
  18         type = lib.types.bool;
  19       };
  20     };
  21   };
  22
  23   config = lib.mkIf cfg.enable {
  24     systemd.services.photonvision = {
  25       description = "PhotonVision, the free, fast, and easy-to-use computer vision solution for the FIRST Robotics Competition";
  26
  27       wantedBy = [ "multi-user.target" ];
  28       after = [ "network.target" ];
  29
  30       serviceConfig = {
  31         ExecStart = lib.getExe cfg.package;
  32
  33         # ephemeral root directory
  34         RuntimeDirectory = "photonvision";
  35         RootDirectory = "/run/photonvision";
  36
  37         # setup persistent state and logs directories
  38         StateDirectory = "photonvision";
  39         LogsDirectory = "photonvision";
  40
  41         BindReadOnlyPaths = [
  42           # mount the nix store read-only
  43           "/nix/store"
  44
  45           # the JRE reads the user.home property from /etc/passwd
  46           "/etc/passwd"
  47         ];
  48         BindPaths = [
  49           # mount the configuration and logs directories to the host
  50           "/var/lib/photonvision:/photonvision_config"
  51           "/var/log/photonvision:/photonvision_config/logs"
  52         ];
  53
  54         # for PhotonVision's dynamic libraries, which it writes to /tmp
  55         PrivateTmp = true;
  56       };
  57     };
  58
  59     networking.firewall = lib.mkIf cfg.openFirewall {
  60       allowedTCPPorts = [ 5800 ];
  61       allowedTCPPortRanges = [{ from = 1180; to = 1190; }];
  62     };
  63   };
  64 }