PyMU package

aggPhasor

client

class Client(theDestIp, theDestPort, proto='TCP', sockType='INET')

Bases: object

Client class that creates a client and provides simple functions for connecting to PMUs or PDCs without needing to directly use Python’s socket library. Supports INET and UNIX sockets

Parameters:

• theDestIp (str) – IP address to connect to. If using unix socket this is the file name to connect to
• theDestPort (int) – Port to connect to
• proto (str) – Protocol to use. Accepts TCP or UDP
• sockType (str) – Type of socket to create. INET or UNIX

connectToDest()

Connect socket to destination IP:Port. If UNIX socket then use destIP

createSocket()

Create socket based on constructor arguments

readSample(bytesToRead)

Read a sample from the socket

Parameters:bytesToRead (int) – Number of bytes to read from socket Returns:Byte array of data read from socket

sendData(bytesToSend)

Send bytes to destination

Parameters:bytesToSend (int) – Number of bytes to send

setTimeout(numOfSecs)

Set socket timeout

Parameters:numOfSecs (int) – Time to wait for socket action to complete before throwing timeout exception

stop()

Close the socket connection

pmuCommandFrame

class CommandFrame(commandStr, pmuIdInt, debug=False)

Bases: pymu.pmuFrame.PMUFrame

Class for creating a Command Frame based on C37.118-2005

Parameters:

• commandStr (str) – Command to send
• pmuIdInt (int) – Frame ID of PMU
• debug (bool) – Print debug statements

createCommand()

Create each field based on the command to send and the frame ID

genChk(crcInputData)

Generate CRC-CCITT based on command frame

genCmd()

Generate command as hex str

Returns:Command field bytes as hex str

genFracsec()

Generate fraction of seconds based on current time

Returns:FRACSEC field bytes as hex str

genIdcode()

Returns:ID code field bytes as hex str

genSoc()

Generate second of century based on current time

Returns:SOC field bytes as hex str

genSync()

Returns:Sync field bytes as hex str

pmuConfigFrame

Class for parsing Config Frame 1 or 2

class Anunit(anunitHexStr, debug=False)

Bases: object

Class for conversion factor for analog channels

Parameters:anunitHexStr (str) – Conversion factor for analog channels field in hex str format

parseAnlgMsrmnt()

Parse analog measurement type

parseUserDefinedScale()

Parse user defined scaling

class ConfigFrame(frameInHexStr, debug=False)

Bases: pymu.pmuFrame.PMUFrame

Parses Config Frame (1 or 2)

Parameters:

• frameInHexStr (str) – Config frame as byte array in hex str format
• debug (bool) – Print debug statements

finishParsing()

After first 4 bytes are received, the client reads the remaining config frame bytes. This function parses those remaining bytes

parseDATARATE()

Parse data rate at which data will be received

parseNUM_PMU()

Parse number of PMUs sending data

parseStations()

Parse station names for each PMU

parseTIME_BASE()

Parses resolution of FRACSEC

class Digunit(digunitHexStr, debug=False)

Bases: object

Class for mask of digital status words

Parameters:digunitHexStr (str) – Conversion factor for digital status channels field in hex str format

class Phunit(phunitHexStr, debug=False)

Bases: object

Class for conversion factor for phasor channels

Parameters:phunitHexStr (str) – Conversion factor field in hex str format

parseValue()

Parse value of conversion factor

parseVoltOrCurr()

Determine if measurement type is voltage or current

class Station(theStationHex, debug=False)

Bases: object

Class for parsing station information including all PMU information. Fields 8-19

Parameters:

• theStationHex (str) – Station fields in hex str format
• debug (bool) – Print debug statements

parseANNMR()

Parses number of analog values field

parseANUNIT()

Parse conversion factor for analog channels

parseCFGCNT()

Parse configuration change count

parseCHNAME()

Parses phasor and channel names field

parseDGNMR()

Parses number of digital values field

parseDIGUNIT()

Parse mask words for digital status words

parseFNOM()

Nominal line frequency code and flags

parseFORMAT()

Parses data format field

parseIDCODE_data()

Parses station ID code field

parsePHNMR()

Parses number of phasors field

parsePHUNIT()

Parse conversion factor for phasor channels

parseSTN()

Parses station name field

updateLength(sizeToAdd)

Updates length of station frames only

Parameters:sizeToAdd (int) – Number of bytes to add to frame length

class TimeBase(timeBaseHexStr, debug=False)

Bases: object

Class for parsing the TIME_BASE word

pmuDataFrame

class DataFrame(frameInHexStr, theConfigFrame, debug=False)

Bases: pymu.pmuFrame.PMUFrame

Class for creating a Data Frame based on C37.118-2011

Parameters:

• frameInHexStr (str) – Data frame bytes as hex str
• theConfigFrame (ConfigFrame) – Config frame describing the data frame
• debug (bool) – Print debug statements

parsePmus()

Parses each PMU present in the data frame

updateSOC()

class PMU(pmuHexStr, theStationFrame, debug=False)

Bases: object

Class for a PMU in a data frame

Parameters:

• pmuHexStr (str) – Bytes of PMU fields in hex str format
• theStationFrame (Station) – Station fields from config frame describing PMU data
• debug (bool) – Print debug statements

parseAnalog()

Parse analog data

parseDfreq()

Parse rate of change of frequency (ROCOF)

parseDigital()

Parse digital data

parseFreq()

Parse frequency

parsePhasors()

Parse phasor estimates from PMU

parseStat()

Parse bit mapped flags field

updateLength(sizeToAdd)

Keeps track of length for PMU frame only

class Phasor(thePhsrValHex, theStationFrame, theName, debug=False)

Bases: object

Class for holding phasor information

Parameters:

• thePhsrValHex (str) – Phasor values in hex str format
• theStationFrame (Station) – Station frame which describe data format
• theName (str) – Name of phasor channel
• debug (bool) – Print debug statements

parseFmt()

Parse format and type of phasor

parseVal()

Parse phasor value

toPolar(hexVal)

Convert bytes to polar values

toRect(hexVal)

Convert bytes to rectangular values

class Stat(statHexStr, debug=False)

Bases: object

Class for foling bit mapped flags

Parameters:

• statHexStr (str) – Stat field in hex string format
• debug (bool) – Print debug statements

parseConfigChange()

Parse config change bit

parseDataError()

Parse data error bits

parseDataModified()

Parse data modified bit

parsePmuSync()

Parse PMU sync bit

parsePmuTrigger()

Parse PMU trigger bit

parseSorting()

Parse data sorting bit

parseTimeQuality()

Parse time quality bits

parseTriggerReason()

Parse trigger reason bits

parseUnlockTime()

Parse unlocked time bits

pmuEnum

File containing all the enums used for PyMU. For detailed explanations please look at C37.118-2005 standard

class AnlgMsrmnt

Bases: enum.Enum

class Command

Bases: enum.Enum

class ConfigChange

Bases: enum.Enum

class DataError

Bases: enum.Enum

class DataModified

Bases: enum.Enum

class FrameType

Bases: enum.Enum

class FundFreq

Bases: enum.Enum

class MeasurementType

Bases: enum.Enum

class NumType

Bases: enum.Enum

class PhsrFmt

Bases: enum.Enum

class PmuSync

Bases: enum.Enum

class Sorting

Bases: enum.Enum

class TimeQuality

Bases: enum.Enum

class Trigger

Bases: enum.Enum

class TriggerReason

Bases: enum.Enum

class Unit

Bases: enum.Enum

class UnlockedTime

Bases: enum.Enum

pmuFrame

class PMUFrame(frameInHexStr, debug=False)

Bases: object

Super class for all C37.118-2005/C37.118-2011 frames

Parameters:

• frameInHexStr – Bytes from frame (any time) in hex str format
• debug (bool) – Print debug statements

finishParsing()

When getting the config frame, the size is unknown. After creating a PMUFrame with the first 4 bytes, the remaining frame bytes are read and added to self.frame. Once that is populated the remaining fields can be parsed

parseCHK()

Parse CRC-CCITT word

parseFRACSEC()

Parse fraction of second and time quality word

parseFRAMESIZE()

Parse frame size

parseIDCODE()

Parse data stream ID number

parseSOC()

Parse second-of-century timestamp

parseSYNC()

Parse frame synchronization word

updateLength(sizeToAdd)

Keeps track of index for overall frame

class SOC(socHexStr, debug=False)

Bases: object

Class for second-of-century (SOC) word (32 bit unsigned)

Parameters:

• socHexStr (str) – Second-of-century byte array in hex str format
• debug (bool) – Print debug statements

parseSecCount()

Parse SOC into UTC timestamp and pretty formatted timestamp

class SYNC(syncHexStr, debug=False)

Bases: object

Class for describing the frame synchronization word

Parameters:

• syncHexStr (str) – Sync byte array in hex str format
• debug (bool) – Print debug statements

parseType()

Parse frame type

parseVers()

Parse frame version

pmuLib

Commonly used functions for parsing PMU Frames

bytesToFloat(b)

Converts byte array to double

Parameters:b (byte-array) – Byte array to convert Returns:Float value

bytesToHexStr(bytesInput)

Converts byte array to hex str

Parameters:bytesInput (byte-array) – byte array to convert Returns:Hex string representing bytesInput

doubleToBytes(f)

Converts double to byte array

Parameters:f (double) – Double value to convert Returns:Byte array representation of double value

doubleToHex(f)

Converts double to hex

Parameters:f (double) – Double value to convert Returns:Hex representation of double value

doubleToHexStr(f)

Converts double to hex str

Parameters:f (double) – Double value to convert Returns:Hex string representation of double value

hexToBin(hexStr, numOfBits)

Converts hex string to binary

Parameters:

• hexStr (str) – Hex value in string format
• numOfBits (int) – Number of bits to convert

Returns:

bits representing the hex values

intToBytes(i)

Converts unsigned int to byte array

Parameters:i (int) – Integer value to convert Returns:Byte array representing i

intToHexStr(i)

Converts int to hex

Parameters:i (int) – Integer value to convert Returns:Hex string representing i

server

class Server(thePort, proto='TCP', printInfo=False)

Bases: object

Server class that creates a server and provides simple functions for incoming connections/data from PMUs or PDCs without needing to directly use Python’s socket library. Supports INET sockets only (will eventually be updated).

Parameters:

• thePort (int) – Local port to listen on
• proto (str) – Protocol to use. Accepts TCP or UDP
• printInfo (bool) – Specifies whether or not to print debug statements

readSample(length)

Will read exactly exactly as many bytes as specified by length and return them as an int

setTimeout(numOfSecs)

Set socket timeout

Parameters:numOfSecs (int) – Time to wait for socket action to complete before throwing timeout exception

startServer(queueLen)

Starts the python server and listens for connections

Parameters:queueLen (int) – Max number of queued connections. Usually defaults to 5

stop()

Closes server connections

waitForConnection()

Will block program execution until a connection is achieved

tools

Tools for common functions relayed to commanding, reading, and parsing PMU data

createAggPhasors(configFrame)

Creates an array of aggregate phasors for data collection

Parameters:configFrame (ConfigFrame) – ConfigFrame containing stations Returns:List containing all the station AggPhasor objects

getDataSample(rcvr, debug=False)

Get a data sample regardless of TCP or UDP connection

Parameters:

• rcvr (Client/Server) – Object used for receiving data frames
• debug (bool) – Print debug statements

Returns:

Data frame in hex string format

getStations(configFrame)

Returns all station names from the config frame

Parameters:configFrame (ConfigFrame) – ConfigFrame containing stations Returns:List containing all the station names

parseSamples(data, configFrame, pmus)

Takes in an array of dataFrames and inserts the data into an array of aggregate phasors

Parameters:

• data (List) – List containing all the data samples
• configFrame (ConfigFrame) – ConfigFrame containing stations
• pmus (List) – List of phasor values

Returns:

List containing all the phasor values

readConfigFrame2(cli, debug=False)

Retrieve and return config frame 2 from PMU or PDC

Parameters:

• cli (Client) – Client connection to data source
• debug (bool) – Print debug statements

Returns:

Populated ConfigFrame

requestConfigFrame2(cli, idcode)

Send command to request config frame 2

Parameters:

• cli (Client) – Client connection to data source
• idcode (int) – Frame ID of data source

startDataCapture(idcode, ip, port=4712, tcpUdp='TCP', debug=False)

Connect to data source, request config frame, send data start command

Parameters:

• idcode (int) – Frame ID of PMU
• ip (str) – IP address of data source
• port (int) – Command port on data source
• tcpUdp (str) – Use TCP or UDP
• debug (bool) – Print debug statements

Returns:

Populated pymu.pmuConfigFrame.ConfigFrame object

turnDataOff(cli, idcode)

Send command to turn off real-time data

Parameters:

• cli (Client) – Client being used to connect to data source
• idcode (int) – Frame ID of data source

turnDataOn(cli, idcode)

Send command to turn on real-time data

Parameters:

• cli (Client) – Client connection to data source
• idcode (int) – Frame ID of data source

transferFrame

class PhasorField(phasor, idNum, theUnits)

Bases: object

Class to hold simplified phasor fields

Parameters:

• phasor (Phasor) – Phasor containing measurements
• idNum (int) – Frame ID to use
• theUnits (str) – Volts or Amps

createPhasorFieldFrame()

Create phasor field frame inside full transfer frame

parseOptions()

Parse options and create bytes as hex str

class TransferFrame(inputDataFrame)

Bases: object

Custom class meant to create a message that can be passed to a socket connection. Only contains timestamp, phasor values, and ID for each phasor

Parameters:inputDataFrame (pmuDataFrame) – Populated data frame containing measurement values

createFullFrame()

Put all the pieces to together to create full transfer frame

genCrc()

Generate CRC-CCITT

parseDataSample()

Parse the input data sample

parsePhasors()

Parse the phasors in the data sample to extract measurements