forked from iRobotEducation/create3_docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.py
191 lines (166 loc) · 8.89 KB
/
main.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
'''
BSD 3-Clause License
Copyright (c) 2022, Rudis Laboratories
Additions Copyright (c) 2022 iRobot Corporation
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Requires mkdocs-macros-plugin:
pip3 install mkdocs-macros-plugin
listfiles() function used in:
print_compute.md
print_casters.md
print_generic.md
print_sensor_mounts.md
Generates in those files a 3D viewable tree structure of model files.
Set env.variables['branch'] to the branch with your updated file structures pushed, ex: "jinja-ninja".
Set env.variables['org'] to your github organization name, ex: "rudislabs".
Set env.variables['render_size_limit'] to max size in kB of stl file for 3D viewing, if above set size include a png image in file structure for viewer to use.
Currently using details in local .git to generate branch and org names.
'''
import os
class cl:
GRN = '\033[92m'
WARN = '\033[93m'
FAIL = '\033[91m'
END = '\033[0m'
BOLD = '\033[1m'
# Begining of optional block and can be commented out if setting env.variables manually
try:
from git import Repo
except ImportError:
print('\n\n{:s}{:s}ERROR\t - Unable to import Python module "git", check to see if GitPython is installed.{:s}\n\n'.format(cl.FAIL,cl.BOLD,cl.END))
currentGitBranch = 'main'
currentGitOrg = 'iRobotEducation'
print('\n{:s}WARN\t - Using github organization in main.py:{:s} {:s}'.format(cl.WARN,cl.END,currentGitOrg))
print('{:s}WARN\t - Using git branch in main.py:{:s} {:s}\n'.format(cl.WARN,cl.END,currentGitBranch))
else:
repo = Repo(os.getcwd())
assert not repo.bare
currentGitOrg = repo.remotes.origin.url.split('.git')[0].replace('[email protected]:','').replace('https://github.com/','').split('/')[-2]
currentGitBranch = repo.active_branch.name
print('INFO\t - {:s}Using github organization in main.py:{:s} {:s}'.format(cl.GRN,cl.END,currentGitOrg))
print('INFO\t - {:s}Using git branch in main.py:{:s} {:s}'.format(cl.GRN,cl.END,currentGitBranch))
# End of optional block
flagImageMesh = False
flagImageMeshCleanup = False
try:
from stl.mesh import Mesh
except ImportError:
print('\n\n{:s}{:s}WARN\t - Unable to import Python module "stl", check to see if numpy-stl is installed, disregard if not building STL images.{:s}\n\n'.format(cl.WARN,cl.BOLD,cl.END))
else:
try:
import vtkplotlib as vpl
except ImportError:
flag_gen_image = False
print('\n\n{:s}{:s}WARN\t - Unable to import Python module "vtkplotlib", check to see if vtkplotlib is installed, disregard if not building STL images.{:s}\n\n'.format(cl.WARN,cl.BOLD,cl.END))
else:
flagImageMesh = True
try:
from PIL import Image
except ImportError:
print('\n\n{:s}{:s}WARN\t - Unable to import Python module "PIL", check to see if PIL is installed, disregard if not building STL images.{:s}\n\n'.format(cl.WARN,cl.BOLD,cl.END))
else:
flagImageMeshCleanup = True
def define_env(env):
env.variables['branch'] = currentGitBranch
env.variables['org'] = currentGitOrg
env.variables['render_size_limit'] = "5000"
@env.macro
def listfiles(path):
fileDetails={}
for root, dirs, files in os.walk(path, topdown=False):
dirs.sort()
for file in files:
if ".stl" in file:
dirDepth=[]
root_str=os.path.join(root,file)
fileSize=float(os.path.getsize(os.path.join(root,file)))/1000.0
fileSize_str=f"{int(fileSize):d} kB"
if fileSize > 500:
# Switch to using MB if above 500 kB
fileSize_str=f"{fileSize/1000.0:.2f} MB"
while path != os.path.dirname(root_str):
# Replace underscores in file folders with spaces, this creates the ToC tree.
dirDepth.append(os.path.basename(os.path.dirname(root_str)).replace('_',' '))
root_str=os.path.dirname(root_str)
entry={"name": file,
"path": root.replace('docs/',''),
"size_str": fileSize_str,
"size_raw_kb": str(fileSize),
"extension": "stl"}
if len(dirDepth) == 1:
if dirDepth[0] not in fileDetails:
fileDetails.update({dirDepth[0]:{}})
fileDetails[dirDepth[0]].update(entry)
if len(dirDepth) == 2:
if dirDepth[1] not in fileDetails:
fileDetails.update({dirDepth[1]:{dirDepth[0]:{}}})
if dirDepth[0] not in fileDetails[dirDepth[1]]:
fileDetails[dirDepth[1]].update({dirDepth[0]:{}})
fileDetails[dirDepth[1]][dirDepth[0]].update(entry)
if len(dirDepth) == 3:
if dirDepth[2] not in fileDetails:
fileDetails.update({dirDepth[2]:{dirDepth[1]:{dirDepth[0]:{}}}})
if dirDepth[1] not in fileDetails[dirDepth[2]]:
fileDetails[dirDepth[2]].update({dirDepth[1]:{dirDepth[0]:{}}})
if dirDepth[0] not in fileDetails[dirDepth[2]][dirDepth[1]]:
fileDetails[dirDepth[2]][dirDepth[1]].update({dirDepth[0]:{}})
fileDetails[dirDepth[2]][dirDepth[1]][dirDepth[0]].update(entry)
return fileDetails
@env.macro
def check_generate(file_path):
name_file = './docs/'+file_path
image_name = name_file.replace(".stl",".png")
if not os.path.exists(image_name):
if flagImageMesh:
print('INFO\t - {:s}Attempting to generate:{:s} {:s} -> {:s}'.format(cl.GRN,cl.END,name_file,image_name))
try:
mesh = Mesh.from_file(name_file)
fig=vpl.figure()
vpl.mesh_plot(mesh,fig=fig,color=(60,116,179))
vpl.save_fig(path=image_name, trim_pad_width=5, pixels=640, off_screen=True, fig=fig)
except:
return False
print('ERROR\t - {:s}Failed to generate:{:s} {:s} -> {:s}'.format(cl.FAIL,cl.END,name_file,image_name))
else:
if flagImageMeshCleanup:
try:
img = Image.open(image_name)
img = img.convert("RGBA")
pixdata = img.load()
width, height = img.size
for y in range(height):
for x in range(width):
if pixdata[x, y] == (216, 220, 214, 255):
pixdata[x, y] = (255, 255, 255, 0)
img.save(image_name, "PNG")
except:
print('WARN\t - {:s}Failed to remove background in:{:s} {:s}'.format(cl.WARN,cl.END,image_name))
return True
else:
return True
else:
return True
else:
print('WARN\t - {:s}Image does not exist and is not generated, not using in docs:{:s} {:s}'.format(cl.WARN,cl.END,image_name))
return False
return True