hutcheb / acd Goto Github PK

View Code? Open in Web Editor NEW

33.0 11.0 10.0 16.57 MB

Rockwell ACD Tools

License: Apache License 2.0

Python 86.82% Kaitai Struct 13.18%

acd l5x logix rockwell

acd's Introduction

Rockwell ACD Project File Tools

The Rockwell ACD file is an archive file that contains all the files that are used by RSLogix/Studio 5000.

It consists of a number of text files containing version information, compressed XML files containing project and tag information as well as a number of database files.

This library allows you to unzip all the files and extract information from these files.

Installing

To install acd tools from pypi run

pip install acd-tools

Parsing the ACD file

To get the Controller object and get the program/routines/rungs/tags/datatypes, use something like this

from acd.api import ImportProjectFromFile

controller = ImportProjectFromFile("../resources/CuteLogix.ACD").import_project().controller
rung = controller.programs[0].routines[0].rungs[0]
data_type = controller.data_types[-1]
tag_name = controller.tags[75].text
tag_data_type =  controller.tags[75].data_type

Unzip

To extract the file use the acd.api.ExtractAcdDatabase class. This extracts the database files to a directory.

from acd.api import ExtractAcdDatabase

ExtractAcdDatabase('CuteLogix.ACD', 'output_directory').extract()

Extract Raw Records From ACD Files

A select number of database files contain interesting information. This will save each database record to a file to make it easier to see whats in them.

from acd.api import ExtractAcdDatabaseRecordsToFiles

ExtractAcdDatabaseRecordsToFiles('CuteLogix.ACD', 'output_directory').extract()

Dump Comps Database Records

The Comps database contains a lot of information and can be export as a directory structure to make it easier to look at. It will also extract the CIP class and instance and write it to the log file.

from acd.api import DumpCompsRecordsToFile

DumpCompsRecordsToFile('CuteLogix.ACD', 'output_directory').extract()

Converting from ACD to L5X

This hasn't been started but could be feasible eventually.

acd's People

Contributors

Stargazers

Watchers

Forkers

dmroeder pwsys jaesungreemei tlf30 vadoola 0001ca zachdv cranetrainenergetic rpabech

acd's Issues

ACD with IOs for testing

Test_IO.zip

See attached Template ACD with IOs

Listing Forces

Is there a way to extract forces? Any kind of hint would be much appreciated. I'm suspecting it has to do something with xrefs.dat. Any hints to parse xrefs?

UnicodeDecodeError

There is a decode error I think error handling system has to be in place

Hi I came across this project several months ago, and was interested, but never had time to dig into it much. About 1-2 months ago I had a bit of time, and noticed this project hadn't been updated in a while. Thinking this project might be dead, I actually started digging through your code, and building a Kaitai Struct File based on it, that I might be able to use later to try and change/expand/make my own version of this library.

I notice now that the project isn't dead, just was on hiatus, and while I haven't finished these Kaitai Struct files, they still might be useful (and maybe I will get some time to keep working on them). I was wondering if you might be interested in adding them to your repo, or if you think you would use them at all?

If you aren't familiar Katai Struct, you essentially create a YAML file describing a binary file format. You can use the IDE to visualize files as you work on the YAML file. I find it useful when reverse engineering file formats.

You can then use the Katai Struct compiler to generate parsing code in a bunch of different languages, including Python.

Let me know if you are interested, and I'll see if I can clean them up a bit and do a pull request. I've been meaning to clean them up and make the repo public but I just haven't had a chance.

Decoding Errors

Hello,

I have a decoding error, I am using version 0.2a8.
This decoding error seems to be referencing a key that doesn't exist.
I have used 2 different ACD files with both failing in the same section.

This is the error message:
"elements.py", line 394, in build name_length = struct.unpack("<H", extended_records[0x01][0:2])[0] KeyError: 1"
And this is the INFO message
2024-07-29 07:51:00.027 | INFO | acd.l5x.export_l5x:post_init:117 - Getting records from ACD Nameless file and storing in sqllite database

self._db.commit() inside the loop

Is there any reason these self._db.commit() lines indented into the for loop?

       log.info("Getting records from ACD Comments file and storing in sqllite database")
        comments_db = DbExtract(os.path.join(self._temp_dir, "Comments.Dat"))
        for record in comments_db.records:
            CommentsRecord(self._cur, record)
            self._db.commit()

        log.info("Getting records from ACD Nameless file and storing in sqllite database")
        nameless_db = DbExtract(os.path.join(self._temp_dir, "Nameless.Dat"))
        for record in nameless_db.records:
            NamelessRecord(self._cur, record)
            self._db.commit()

The id's that can be extracted from comments.dat doesn't seem to have a relation to components or other parts.