joshooaj

MilestonePSTools PowerShell Module

Description

MilestonePSTools is my (Josh Hendricks) side project exploring the various ways PowerShell can be used to enable automation and overall enhance the experience of configuring or querying a Milestone XProtect VMS environment. This module is written in C# and is effectively a PowerShell-friendly wrapper around Milestone's MIP SDK.

There is nothing in this module that is not possible to build using the .NET components from the MIP SDK directly in your scripts, but doing so quickly becomes complicated, and difficult to maintain. This was my experience when exploring writing PS1 scripts where I imported MIP SDK dll's directly into my scripts, handled authentication and .NET object instantiation for

joshooaj

private void GetRecordedSnapshot()
{
    JPEGVideoSource src = null;
    var cameraId = Camera == null ? CameraId : new Guid(Camera.Id);
    try
    {
        var item = Configuration.Instance.GetItem(Connection.CurrentSite.FQID.ServerId, cameraId, Kind.Camera);
        if (item == null)
        {
            WriteWarning($"Configuration not available for camera with ID {cameraId}. It might be disabled.");

joshooaj

## Create a basic user and add it to a role

$ms = Get-ManagementServer
$role = Get-Role -Name "MyUsers"
$result = $ms.BasicUserFolder.AddBasicUser("User1", "Suitable description", "S3cretP@sscode")
if ($result.State -eq "Success") {
    $user = $ms.BasicUserFolder.BasicUsers | Where-Object Path -eq $result.Path
    $role | Add-User -Sid $user.Sid
} else {
    Write-Error $result.ErrorText

joshooaj

using System;
using System.Linq;
using System.Management.Automation;
using VideoOS.Platform;
using VideoOS.Platform.ConfigurationItems;
using VideoOS.Platform.Data;

namespace MilestonePSTools.SnapshotCommands
{
    /// <summary>

joshooaj

function ReplaceInvalidFilenameChars {
    param(
        [string]
        $text,
        [string]
        $substition
    )

    foreach ($c in [System.IO.Path]::GetInvalidFileNameChars()) {
        $text = $text.Replace($c, $substition)

joshooaj

function Set-CertificatePermission {
    [CmdletBinding()]
    param(
        [string]
        $CertificatePath,
        [string]
        $UserName,
        [string]
        $Permission
    )

joshooaj

using System;
using System.Threading;
using VideoOS.Platform;
using VideoOS.Platform.Live;

namespace SampleSnapshotService
{
    public class StreamReceiver : IDisposable
    {
        private readonly Item _item;

joshooaj

using System;
using System.Management.Automation;
using VideoOS.Common.Proxy.Server.WCF;

namespace MilestonePSTools.BookmarkCommands
{
    /// <summary>
    /// <para type="synopsis">Gets one or more bookmarks based on the supplied parameters</para>
    /// <para type="description">Gets all bookmarks matching the supplied parameters. If there is any
    /// overlap between the timespan represented by the StartTime and EndTime parameters, and the

joshooaj

function Import-TripCheck {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory, ValueFromPipeline)]
        [VideoOS.Platform.ConfigurationItems.RecordingServer]
        $Recorder,

        [Parameter(Mandatory)]
        [string]
        $ApiKey,

joshooaj

function New-Timelapse {
    <#
    .SYNOPSIS
    Exports still images from XProtect and creates a timelapse video using ffmpeg.
    
    .DESCRIPTION
    This example function saves jpeg images from the recordings of the specified
    camera to a temp folder, and uses these images as input to the ffmpeg
    command-line utility to generate a timelapse video from the images.